Integration tests
Before a publisher can enable their API integration, a series of integration tests must pass. These scenario-based integration tests are designed to run frequently & automatically and ensure that your API is working as expected.
Integration tests can be configured in the GetFTR portal, here .
To configure your integration tests, provide as many scenarios and expected responses as possible.
Test configuration table
| Column | Description |
|---|---|
| Test Scenario | The type of scenario to test against your API |
| Organization identifiers | Provide the described type of identifier, EntityId IPv4, IPv6, etc. |
| DOI | The DOI to test the response against your API |
| Entitled | Whether or not the response should indicate the provided identifier is entitled to the DOI |
| Status | The last known status of the test |
Test scenarios
| Scenario | Description |
|---|---|
| IP Address | Test a specific IPv4 or IPv6 address to determine if a user is entitled (or not) to a specific DOI |
| SAML | Test an EntityId, OpenAthens or Shibboleth identifier against a DOI |
| Open Access | Test a specific DOI to determine if the response (accessType) indicates it is OA |
| Perm Free | Test a specific DOI to determine if the response (accessType) indicates it is permanently free to read |
| Free DOI | Test a specific DOI to determine if the response (accessType) indicates it is free to read |
| Unknown DOI | Test an integration responds correctly to a request containing a DOI that does not belong to the Publisher |
| Unknown Org | Test an integration responds correctly to a request containing an organization identifier that is unknown or malformed |
Last updated on