Integrishield API Documentation

Version: 1.0 Base URL: https://app.integrishield.com/api

Introduction

Welcome to the Integrishield API documentation! This guide provides the necessary details for integrating your systems with our API to manage Compliance URLs and Affiliates associated with your company account.

Please review the Authentication and Response Codes sections before proceeding to specific endpoint documentation.

Authentication

All API endpoints require authentication using a Bearer Token provided by Integrishield. You must include the following headers in every API request:

Authorization: Bearer <YOUR_API_TOKEN>
Accept: application/json

For requests that send data in the body (typically POST and PUT requests), you must also include the Content-Type header:

Content-Type: application/json

If your request is not properly authenticated, the API will respond with a 401 Unauthorized status code. Ensure your token is valid and correctly included in the Authorization header.

Rate Limiting

API requests are limited to 1,000 requests per minute per authenticated user. If you exceed this limit, the API will respond with a 429 Too Many Requests HTTP status code. Wait briefly before retrying your request.

Response Codes and Status

The API uses standard HTTP status codes (like 200 OK, 201 Created, 404 Not Found, 422 Unprocessable Entity, etc.) to indicate the overall success or failure of a request.

Additionally, the JSON response body often contains custom code and status fields to provide more specific feedback, especially useful for batch operations where individual items might succeed or fail.

Common Response Structure:

{
  "code": "...",    // Custom status code (see table below)
  "status": "...",  // "ok" or "error"
  "detail": {
    "msg": "..." // User-friendly message describing the result
    // Other relevant details like 'affiliate_id', 'url_id' may appear here
  },
  "data": [] or {} // Optional: Contains resource data for GET requests (e.g., list of affiliates)
}

Custom Status Codes Table:

This table explains the meaning of the custom code values you might encounter in the JSON response body:

Code	Status	Meaning	Typical HTTP Status
1020	ok	Operation successful (Create/Update/Found)	200, 201
1021	error	Failed to process item (e.g., DB error)	201, 207*
1023	error	Item already exists (e.g., URL, Name)	201, 207*, 409
1024	error	Invalid related data (e.g., Country Code)	201, 207*
1025	error	Resource not found	404
1026	ok	Resource(s) found (List/Show)	200
401	error	Authentication issue	401
500	error	General server error	500

* Codes 1021, 1023, 1024 can appear within a 201 Created or 207 Multi-Status HTTP response when processing bulk items. They indicate an issue with a specific item in the batch, while the overall request might have partially succeeded.