What are the Haptik API Requisites
Written by Soham Amburle
Updated on April 19th, 2023
- Getting Started
- Bot Building
- Smart Agent Chat
- Conversation Design
-
Developer Guides
Code Step Integration Static Step Integration Shopify Integration SETU Integration Exotel Integration CIBIL integration Freshdesk KMS Integration PayU Integration Zendesk Guide Integration Twilio Integration Razorpay Integration LeadSquared Integration USU(Unymira) Integration Helo(VivaConnect) Integration Salesforce KMS Integration Stripe Integration PayPal Integration CleverTap Integration Fynd Integration HubSpot Integration Magento Integration WooCommerce Integration Microsoft Dynamics 365 Integration
- Deployment
- External Agent Tool Setup
- Analytics & Reporting
- Notifications
- Commerce Plus
- Troubleshooting Guides
- Release Notes
Table of Contents
Pre-requisites for consuming the APIs for development purposesRequired API Details for TestingThe main objective of this document is to highlight the requirements for APIs that are made available to Haptik for the development of an Intelligent Virtual Agent (IVA). Haptik will consume API endpoints in scenarios where data needs to be fetched and presented to the end-user.
Pre-requisites for consuming the APIs for development purposes
- All APIs should preferably be Restful APIs that use HTTP requests to GET, PUT, POST, and DELETE data.
- API documentation containing clear instructions about how to effectively use and integrate with the API endpoint.
- The document should explain the various API endpoints, how to construct requests, and what to expect as a response.
- Each endpoint should contain the following details:
- Endpoint URL.
- The path to call each endpoint.
- Which HTTP methods can be used with each endpoint.
- Authentication and other headers are required with each request.
- Explanation of what request data is mandatory and what is optional.
- Example Request Body.
- Example Response Body.
- Possible Error Scenarios and Status Codes.
- If there is authentication, please provide authentication steps in detail.
- Each endpoint should contain the following details:
- Request and Response must be JSON preferably.
- API endpoints must be publicly accessible.
- In case they are not publicly accessible, Haptik’s IPs must be whitelisted.
- APIs should have a stable Staging/Test environment that can be used during development.
- Any test accounts/IDs as applicable - for eg. dummy mobile numbers, sample user IDs, sample tracking IDs, etc that can be used to test out the APIs should be available.
Required API Details for Testing
| Sr no. | Data | For Example |
| 1 | API Name | API to generate OTP |
| 2 | Method | POST |
| 3 | Endpoint URL | https://apisit.xyz.com/pchflih/otp/v1/generateOTP |
| 4 | Headers |
|
| 5 | Request Body | Request: { "mobileNo":"9928056506", "Attempt id" : "1" } |
| 6 | Success Response | { status:"success", status_code:"SUCC001", message:"Request Successful" } |
| 7 | Error Response |
{ "status": "error", "status_code": "ERR002", "message": "Request Failed" } |
| 8 | Partner Code | "{partnercode}" |
| 9 | Consumer Key, Consumer Secret, User ID and Call back URL | If we are using these or similar, the key name should be properly mentioned. Eg: consumer_key |
| 10 | HTTP Status Codes |
Code Message SUCC001 Request Successful ERR001 Request Failed |
