Profiles API

Ainua Portal user Profiles API provides RESTful access for data integration. It is designed for integrating users profile data from a back-office solution to Ainua Portal. The API does not force any specific profile information but typically it contains information about users company, companys

For added security Profiles API is write-only as are all Ainua Portal API’s.

Note

Profiles API uses bearer_token (obtained within authentication request using a specific connector in Ainua Portal) to bind data to specific data source. Good rule of thumb is to use different connector for each back-office integration.

Updating profile data

Request

PATCH `https://{ainua_url}/api/integrations/v1/profiles`

Header

Content-type:   application/json
Authorization:  Bearer {bearer_token}

Body

{
    "{user1_external_id}":
    {
        "{profile_1_key}": "{profile_1_value}",
        "{profile_2_key}": "{profile_2_value}",
        "{profile_3_key}": "{profile_3_value}",
            :
    },
    :
}

Request will return 200 OK on success.

Example

Request

PATCH `https://example.ainuaportal.com/api/integrations/v1/profiles`

Header

Content-type:   application/json
Authorization:  Bearer eyJhbGciOiJSUzI1Ni... ...PCBGj6DEN02WOIdzXEQ

Body

{
    "user_1000":
    {
        "company": "Y-12345-678",
        "category": "Sports",
        "interest": "Sports;Athletics,Skiing"
    }
}

Response

HTTP/1.0 200 OK