Skip to main content

Step 1: Authentication

Talk to numo before building on this API

Most publishers should not build a direct API integration. numo's hosted White Label UI delivers the full offers experience with minimal engineering, and numo can ingest your card program, card account, and transaction data over a managed SFTP / batch feed — no API development on your side.

The REST API documented here is maintained for a small number of existing direct integrations. If you're a new partner, contact your numo representative to get set up with the White Label UI and an SFTP data feed before writing any API code.

Environments

There are two different environments available to partners. Each environment uses a different base URL.

  • Sandbox: https://api.sandbox.tripleup.dev/
  • Production: https://api.tripleup.dev/

Authentication

numo uses OAuth for authentication (machine-to-machine/server-to-server). After successful onboarding, your numo contact will have provided you with the clientId and clientSecret for both sandbox and production environments. Use the clientId and clientSecret to obtain an access_token. By default, the access_token is valid for 3,600s

curl --location 'https://auth.tripleup.dev/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic {clientId}:{clientSecret}' \
--header 'Cookie: XSRF-TOKEN=5b367412-3873-499a-b615-d5661505de5e' \
--data-urlencode 'grant_type=client_credentials'
tip

Note the usage of Content-Type: application/x-www-form-urlencoded and the body of grant_type=client_credentials

Conventions

ActionDescription
GETUsed to retrieve a representation of a resource.
POSTUsed to create new resources and sub-resources.
PATCHUsed to update existing resources.
DELETEUsed to delete existing resources.