API integration checklist

Owned by Iveta Dvořáková
Last updated: 19.12.2023
3 min read

This should serve as a guide for you if you are planning to integrate any API with the partner, what are the point to discuss with partner, what should be set up on the test environment and what in the production.

Pre-implementation information basis

Decide which API would you like to integrate
Download the appropriate https://gtsalive.atlassian.net/wiki/spaces/APKNOWB/pages/229670913 and share it with IT department of the partner
What type of cards will be issued?
Plastic
Digital
Both
Who will be printing the cards? (in case of plastic one)
What is the validity of the card?

  • it has to be set up in the API

  • it needs to reflect validity setup in the NCDB for whole market

Extension card process
current card_id is extended for next period of time
new card is issued and assigned to existing cardholder
Will there be any custom fields on the card?
What app will be used to display digital cards?
ISIC Global App
Alive App
Partners App

Checklist before requesting test environment API access

Other Points

Testing Scenarios

API for External Issuers

  1. Create a new user

POST /cardholders.set

  1. Upload picture to new user, if using

POST /cardholders.setPhoto

  1. Create a ISIC card with months validity your market is using

    1. report mode

POST /cards.report

b. request mode

  1. Extend the card - based on the chosen option

    1. If the card validity is extended

b. If a new card is issued

  1. Cancel card and its reactivation

Digital cards API

  1. Check if card is displayed correctly

  2. Check with ISO if all criteria are met - such as watermark - see documentation for full list of details

  3. Check all corner cases - such as if the picture od virtual card is not generated yet.

Checklist before requesting production API access