System integration
System integration is where an organisation connects its own customs system to ITS, and where the Secretariat follows and approves that connection. A State Party or a REC uses it to get the credentials its system signs in with, to pass the four Sandbox checks, and, once it is in Live, to say where ITS should send announcements. The Secretariat uses it to onboard organisations, to approve Live access and receiving endpoints, and to suspend, restore or withdraw an organisation.
This chapter describes the screens. The process they belong to, from admission to Live, is told step by step in Onboarding. How your system calls ITS is in the Guides.
Before you start
- System integration is listed for System admin, Secretariat admin, Organisation admin and Partner (the technical contact). See What each role can do.
- Anybody else who types its address sees You do not have access to this area: "System integration is for the Secretariat and admitted partners. Partners use one Portal for Sandbox checks and Live access. Ask the Secretariat to check the role on your ITS account."
How to open it
- Select All areas in the console header.
- Under Administration, select System integration.
Which screen you land on
The same entry opens a different screen depending on who you are.
| You are | You land on | You can also open |
|---|---|---|
| A State Party's Organisation admin or Partner | Your workspace, for your own organisation | |
| A REC's Organisation admin | Your workspace, for the REC | Organisations you file for: the register, limited to your REC and the member States it files for, without the Secretariat's buttons |
| A REC's Partner without Organisation admin | Your workspace, for the REC | |
| Secretariat admin or System admin | The register of every organisation | The review screen of any organisation |
An organisation's administrator and its technical contact see the same workspace and can do the same things in it. In most organisations one person holds both roles.
Sandbox and Live
Every organisation has two separate environments, each with its own credentials.
| Sandbox | Live | |
|---|---|---|
| What it is | A test environment. Declarations sent here stay in Sandbox and never reach a customs authority | Real declarations, sent to customs authorities |
| When it opens | As soon as the Secretariat has onboarded the organisation | When the organisation has passed all four Sandbox checks and the Secretariat has approved the results |
| What the workspace shows | A step-by-step guide whose steps 3 to 6 are the four checks | The organisation's Live status and Announcements to your system |
| How to tell | An amber striped band reading SANDBOX · TEST PLAYGROUND across the top | No band |
The Environment switch in the workspace header moves between the two. While Live is closed its Live button is greyed out and carries a padlock. Once the Secretariat approves Live access, the workspace opens in Live every time you sign in, and you can still switch to Sandbox at any time. The portal does not remember which side you were on.
The states of an organisation
An organisation moves through these states. The register, the Secretariat's review screen and the organisation's own workspace all show the same word.
| Where the organisation is | Shown as |
|---|---|
| Known to ITS, not yet onboarded | Requested |
| Onboarded; no Sandbox credentials yet | Admitted |
| Sandbox credentials exist; checks under way | In Sandbox |
| All four checks passed; waiting for the Secretariat | Certified |
| Live access approved; no Live credentials yet | Live approved |
| Live credentials exist | Live |
| Suspended by the Secretariat | Suspended |
| Withdrawn | Withdrawn |
Two rows deserve a second look:
- Approving Live access is not the last step. The organisation reads Live approved until it creates its first Live credentials, and only then Live. The register's State filter has no Live approved choice: choose Certified to find those organisations too.
- The fourth check certifies the organisation by itself. Nobody presses a button to move an organisation from In Sandbox to Certified.
Pages in this chapter
For a State Party or a REC
- Your workspace: the header, credentials, and the four Sandbox checks.
- Announcements to your system: the receiving endpoint and source addresses, in Live.
For the Secretariat
- The register: every organisation, and onboarding one.
- Review an organisation: approve Live access, manage contacts, suspend, restore and withdraw.
- Approve receiving endpoints: approving the address ITS sends an organisation's announcements to.
Related pages
- Onboarding: the process from admission to Live.
- Authentication and Receiving announcements: what your system does with the credentials and the endpoint.
- Governance: the participation and delegation records an organisation needs before it can be onboarded.
- Reports: Integration: what ITS refused and delivered once the connection is in use.