Articles in this section

Registering the northbound interface to consume IMPACT APIs

Avatar
V, Srinivasa Raju (Nokia - IN/Bangalore)
  • Updated
Follow

Registration

The registration API allows the client applications to register their callback information (including the callback URL) in the IMPACT system. Also, the client application can specify the callback authentication method.

The ADEP client uses the CDP user credential to register on the IMPACT system. Upon successful registration, IMPACT system updates callback information in the database.

Table 1 describes the API structure for the registration process.

TABLE 1 Register API client with callback information
Title Register API client with callback information
URL http://<impact_url>/m2m/applications/registration
Method PUT
Content-Type application/json
URL Params The following are the URL parameters:

  • registrationInput:[body]: Registration body specifies the Base64 encoded authorization in header and URL for callback. If consists of following parameters:

    • headers:[composite]: Specifies the authorization header.

      • callbackAuth:[string]: Indicates the authorization type used by the call back server. If the callback server uses HTTP digest authorization, set this parameter to Digest.

        If the callback server uses basic authorization, do not use this parameter.

        Example:

        "headers":{"authorization":"Basic dXNlcjE6dXNlcjFQYXNz", "callbackAuth":"Digest"}

    • url:[string]: Specifies the callback URL to be provided for notifications.

      Example:

      "headers": {"authorization":"Basic dWF0YWRlcDpBc2RmMSM="}
Data Params Msg:[String]: info/warning/error message
Success Code 
Response Code: 201
Error Code 
400 : Bad Request
401 : Unauthorized 
403 : Forbidden 
404 : Not Found
Sample Call

Curl:

Callback server uses HTTP digest authorization:

curl -X PUT
        --header 'Content-Type: application/json' --header 'Accept: application/json'  --header 'Authorization: Basic ZG9jdXNlcjpBc2RmMSM=' -d
        '{"url":"http://localhost:8080/applications/callback/impact", 
 "headers":{"authorization":"Basic dXNlcjE6dXNlcjFQYXNz", "callbackAuth":"Digest"} 
}' 'http://<impact_url>/m2m/applications/registration'

Callback server uses Basic authorization:

curl -X PUT
        --header 'Content-Type: application/json' --header 'Accept: application/json'  --header 'Authorization: Basic ZG9jdXNlcjpBc2RmMSM=' -d
        '{  "headers": {"authorization":"Basic
        dWF0YWRlcDpBc2RmMSM="},  "url":
        "http://<callback_url>/m2m/impact/callback"
    }' 'http://<impact_url>/m2m/applications/registration'

Response Body:

{
"msg": "Success","code":1000
}
Notes

The system automatically checks the correctness of the callback URL that is, the client application is available at the address during registration.

Related articles

Comments

0 comments

Please sign in to leave a comment.