The Apply service has four different APIs, each of which cater for different audiences and use cases.
📖 Candidate API docs
🔐 Authenticate with ServiceAPIUser
The Candidate API provides candidate information to other services. It's currently only used by the CRM team in Get Into Teaching (GIT).
📖 Data API docs
🔐 Authenticate with ServiceAPIUser
The Data API provides data extracts and reporting about the Apply service. Responses are in CSV format. It's used by the Teacher Analysis Division (TAD) team.
📖 Register API docs
🥸 Also known as the Recruits API
🔐 Authenticate with ServiceAPIUser
The Register API provides the details of successful applications. It's currently only used by the Register service.
At the point an application is retrieved by Register, Register becomes the "source of truth" for that candidate.
📖 Vendor API docs
🔐 Authenticate with VendorAPIToken
The Vendor API allows providers to manage applications programmatically: fetch applications, make offers, reject applications, etc. It makes the key functionality of Manage available via API to vendor Student Record Systems (SRS).
Users of this API authenticate with a Vendor API token. These can be issued and revoked in the support console under Providers > API tokens.