Authenticate
- NEW! - Interactive API docs, now live!
Visit api-docs.plumvoice.com to read Plum API documentation, build and test requests in our interactive API sandbox, review the responses, and share it all with your team.
Authenticate
POST
https://voicetrends.plumvoice.com/api/auth
This service is used to perform initial account authentication. Provide your tool-specific login and password as well as the tool you are attempting to authenticate against. This API is rate-limited to 15 requests per 15-minute window.
Query Parameters
tool
string
The tool you are authenticating against. Allowed values are: “dev”, “insight”, or “fuseplus”.
login
string
The login credential associated with the provided tool.
password
string
The password credential associated with the provided tool.
Headers
content-type
string
application/x-www-form-urlencoded
Possible Response Codes
200: Success, account successfully authenticated.
400: Supplied data improperly formatted or invalid
401: Authentication parameters invalid or the account is inactive
405: Invalid HTTP method supplied (only POST allowed)
429: Rate limit exceeded
500: Unknown error
The return structure will contain the following items:
Name
Data Type
Always Present
Description
error
string
no
This indicates which error occurred if the HTTP code is not 200.
login
string
no
A 200 HTTP code returns this value, which will be used as the login for data access APIs using HTTP Basic Authentication.
password
string
no
A 200 HTTP code returns this value, which will be used as the password for data access APIs using HTTP Basic Authentication.
Sample Code
This sample code makes a request to authenticate an account using PHP, but any language capable of integrating with a REST API works for this type of request:
Last updated