Customer apps

The smart-locker operations for apps and websites of a service provider's customers.

The customer side calls the smart-locker operations of the partner app API at https://open.superroute.ca/app/v1: the operations that sApp offered up to 0.2.1, under the same names, and the second-hand handover operations.

An app that called these operations through sApp 0.2.1 keeps the same operation names; the calls move from the sApp package to the sLocker package. Store orders stay in sApp, opening the locker of a store order and asking for its refund included.

Signing in

An app that uses only sLocker creates the customer client with the app code, the client code of the service provider, the app key and a token store. People sign in the same ways as in sApp. Sign-in · sApp

import { SLocker } from '@superrouteca/slocker-customer';

const locker = SLocker.customer({
  appCode: 'p_acme_parcels',
  clientCode: 'k3m9q2',          // the service provider's client code
  appKey: 'sp_appkey_…',         // restricted key for calls before sign-in
  tokenStore,                    // secure storage: { get, set, clear }
  locale: 'en',
});

await locker.auth.signInWithIdToken(googleIdToken);
const pickups = await locker.api.platformAppPickups({ status: 'ready' });
await locker.api.platformAppCollectPickup({ deliveryId: 42, body: { user_confirmed: true } });
const deals = await locker.api.lockerResaleDeals({ open: true });

An app that already uses sApp passes its sApp client instead. The person signs in once, and both packages use the same tokens.

import 'package:sapp/sapp.dart';
import 'package:slocker_customer/slocker_customer.dart';

final sr = PartnerClient(appCode: 'p_acme_parcels', clientCode: 'k3m9q2', appKey: 'sp_appkey_…', tokenStore: store);
final locker = SLocker.customerFor(sr);
final notifications = await sr.api.platformAppNotifications();   // sApp
final pickups = await locker.api.platformAppPickups(page: 1);     // sLocker

from sapp import PartnerClient
from slocker.customer import customer

sr = PartnerClient('p_acme_parcels', client_code='k3m9q2', app_key='sp_appkey_…')
locker = customer(sapp=sr)
locker.api.platform_app_pickups(status='ready')

import SApp
import SLockerCustomer

let locker: SLockerCustomerClient = SLocker.customer(sapp: sr)
let pickups = try await locker.api.platformAppPickups(status: "ready")

Entries in each language

Each language has an entry for sLocker on its own and one beside an sApp client. Both return a customer with api (one method per operation), the sApp client underneath for sign-in and every other partner operation, and callOperation for an operation described by hand.

Capabilities

Each group needs the app capability shown, switched on for the app by the service provider. A sensitive capability is approved only while the developer account holds the matching permission from Superroute.

Collecting a pickup opens the door remotely and also needs locker.remote_open (app.locker_remote_open).

Operations

Customer API reference · UI kit

Errors and retries

Errors and retries are the same as in sApp: one error type with the HTTP status, the server's code and the parsed body, and signInRequired when the person must sign in again. Repeatable calls are retried; writes are never retried.