OVERVIEW

The Partners API is used to create and manage users in Wrapp via API calls.

GETTING ACCESS

To use the Partners API, contact [email protected] to receive an API key.

Include the API key in your request headers as:

X-PARTNER-API-KEY: <your_key_here>
API Base URL

https://wrapp.ai/api/v1/

# Example header

X-PARTNER-API-KEY: xxxxxxxxxxxxxxxxxxxxxxxxxxx

CREATE / LOGIN USER

To create a new user or log in an existing one, make a POST request to:
https://wrapp.ai/api/v1/external_login

Wrapp.ai will respond with a login_url that the user can use to log in.

PARAMETERS

Param Name Required Type Description
email yes string Email of the user that will be used to create their account in Wrapp.ai
partner_user_id yes string External unique identifier that will be used to identify the user in Wrapp.ai
phone yes string Phone of the user that will be used to create their account in Wrapp.ai
webhook_endpoint no string Webhook endpoint that will return details on user creation
# Example request

curl -L 'https://wrapp.ai/api/v1/external_login' \
-H 'X-PARTNER-API-KEY: XXXXXXXXXXXXXXXXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{
     "email": "[email protected]",
     "partner_user_id": "abc123",
     "phone": "1234567890",
     "webhook_endpoint": "https://yoursite.com/webhook"
}'

Response Success:

{
 "login_url": "https://wrapp.ai/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

WEBHOOK — USER CREATED

If the user was created, Wrapp.ai will send the following payload to the provided webhook_endpoint:

FIELDS

Param Name Description
wrapp_user_id Id of the user in Wrapp
partner_user_id Id of the user in partner (the id provided in the initial call)
api_key API key of the user, used for further API actions on their behalf
# Webhook payload

{
 "wrapp_user_id": "xxxxx-xxxxx-xxxxx-xxxxx",
 "partner_user_id": "xxxxxxxxxx",
 "api_key": "xxxxxxxxxxxxxxxxxxxxx"
}

CHECK USER

This endpoint shows if the user exists and whether they have an active subscription. Make a POST request to:
https://wrapp.ai/api/v1/embedded_check_user

PARAMETERS

Param Name Required Type Description
partner_user_id yes string Unique identifier that has been used to identify the user in Wrapp.ai

RESPONSE FIELDS

Name Type Description
user string User's email
active_subscription boolean User's subscription status
# Example request

curl -L 'https://wrapp.ai/api/v1/embedded_check_user' \
-H 'X-PARTNER-API-KEY: XXXXXXXXXXXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{"partner_user_id": "abc123"}'

Response Success:

{
 "user": "[email protected]",
 "active_subscription": false
}