GET /v1/token/claim

HTTP Method: GET

Path: /v1/token/claim

Authentication: API Key required

Description: Get a URL that allows a user to claim an existing entity (index card) in the Central Index 

Parameters:

parameter type description Required
language string An ISO compatible language code, E.g. en (Default is "en") No
portal_name string

The name of the website that data is to be added on E.g. Your Local

 Yes
entity_id string The id of the entity to be claimed, e.g. 3791234532345 Yes

Sample Response:

{
     "success": true,
     "msg": "Token URL",
     "data": "http://admin.centralindex.com/claim?token=b2ee0622e233a6fb7e95ead313ea7cfec7fddf53aa0f927ed32d133e5e90fe8c4a367fcfae48b7203ac5ca679ce70a2cd8025b5f64e5d665c26dbbd57f8ebd10"
}

 

The API call returns a URL which your user's browser can use to direct people to claim an index card to the Central Index. 

Because this is a key-specific URL, the Central Index knows when a new Index Card is claimed via your application.

version 5 as of 6 years ago by Unknown

Docs Navigation