The Publisher Product API section allows you to view the API documentation for the Product.
To view the API documentation, go to the Publisher Management > Setup > Publisher Products API section.
Select the Product from the list and click the “Select” button. The system will show the API documentation for the selected Product.
The document contains the following information:
To download the documentation in PDF format, click the “Get as PDF” button.
In the Introduction block, you can view the introductory information about the API.
To change the introduction text according to your needs, click the “Edit” sign.
The Overview block contains the following information:
Method: Phonexa accepts leads through the HTTP POST process. Lead generators are asked to send leads via HTTP POST to the URL specified in the Leads Specs section.
Format/Data Type: JSON or FORM.
Fields: Phonexa API contains both required and optional fields. Phonexa will not accept a lead when any of the required fields are omitted, or the value of those fields is null or blank.
Testing: To enable the test mode, add the testMode=1 parameter in the request. You can use the live credentials for testing.
To change the information in the Overview block according to your needs, click the “Edit” sign.
In the Lead Specs block, you can view the lead posting specifications. The information is separated into the following columns:
Field Name: The name of the field.
Required (YES/NO): Shows if the field is required.
Description: The description of the information in the field.
Format: Displays the data format that should be used in the field.
Example: The data examples.
In the Code Samples block, you can view examples of requests in different programming languages:
The Response Samples block contains the templates of responses for accepted or rejected leads. The information is separated into 3 blocks:
Sold Lead (Accepted Customer from Lead Generator): The response samples for accepted leads (editable block).
Reject Lead (Rejected Customer from Lead Generator): The response samples for rejected leads. You can not edit this block.
Error: The response samples for leads with errors. You can not edit this block.
The Intermittent Lead Status Query
In The Intermittent Lead Status Query block, you can view the description of the lead processing method that allows you to reduce the consumption of resources and increase stability.
The Response Examples block contains the response cases according to the lead status. The available statuses are:
In the Test Mode block, you can view the brief instruction on how to send a test lead.