User Management API
Manage user accounts with our API. This API allows you to activate and/or modify multiple options of the user's account, as well as knowing the user's balance.
- HTTP API, Manage users with any programming language.
- 99.9% SLA, We optimize the performance of all servers.
API functionality
Get account balance
Parameter | Description | Compulsory / Optional |
---|---|---|
class=user | Class requested: Class to which the request is made | Compulsory |
method=getbalance | Class method requested: Method of the class to which the request is made | Compulsory |
user | User and e-mail of your Afilnet account | Compulsory |
password | Password of your Afilnet account | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
Code | Description |
---|---|
MISSING_USER | User or email not included |
MISSING_PASSWORD | Password not included |
MISSING_CLASS | Class not included |
MISSING_METHOD | Method not included |
MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
INCORRECT_USER_PASSWORD | Incorrect user or password |
INCORRECT_CLASS | Incorrect class |
INCORRECT_METHOD | Incorrect method |
Parameters:
- class : user
- method : getbalance
- user : user
- password : password
Request:
Add new address
Parameter | Description | Compulsory / Optional |
---|---|---|
class=user | Class requested: Class to which the request is made | Compulsory |
method=addaddress | Class method requested: Method of the class to which the request is made | Compulsory |
user | User and e-mail of your Afilnet account | Compulsory |
password | Password of your Afilnet account | Compulsory |
namelastname | Name and surname of the contact person | Compulsory |
iscompany | (0) If it is a natural person or (1) if it is a company | Compulsory |
companyname | Name of the company (in case it is a company) | Optional |
documentid | Company identification document code | Compulsory |
countrycode | ISO country code in ISO-3166-1 ALPHA-2 format | Compulsory |
cityid | City identifier | Compulsory |
cityname | Name of the city or town to which it belongs | Compulsory |
zipcode | Postal Code | Compulsory |
address | Physical address | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
Code | Description |
---|---|
MISSING_USER | User or email not included |
MISSING_PASSWORD | Password not included |
MISSING_CLASS | Class not included |
MISSING_METHOD | Method not included |
MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
INCORRECT_USER_PASSWORD | Incorrect user or password |
INCORRECT_CLASS | Incorrect class |
INCORRECT_METHOD | Incorrect method |
EMPTY_COUNTRYCODE | The country code is empty |
COUNTRY_NOT_FOUND | There is no country with the indicated code |
EMPTY_CITY | You have not indicated the city |
CITY_NOT_FOUND | The indicated city does not exist |
Parameters:
- class : user
- method : addaddress
- user : user
- password : password
- namelastname : name+lastname
- iscompany : 1
- companyname : mycompany
- documentid : 123456789A
- countrycode : us
- cityid : 1
- cityname : town
- zipcode : 123456
- address : address
Request:
Remove an address
Parameter | Description | Compulsory / Optional |
---|---|---|
class=user | Class requested: Class to which the request is made | Compulsory |
method=deleteaddress | Class method requested: Method of the class to which the request is made | Compulsory |
user | User and e-mail of your Afilnet account | Compulsory |
password | Password of your Afilnet account | Compulsory |
idaddress | User account address ID | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
Code | Description |
---|---|
MISSING_USER | User or email not included |
MISSING_PASSWORD | Password not included |
MISSING_CLASS | Class not included |
MISSING_METHOD | Method not included |
MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
INCORRECT_USER_PASSWORD | Incorrect user or password |
INCORRECT_CLASS | Incorrect class |
INCORRECT_METHOD | Incorrect method |
Parameters:
- class : user
- method : deleteaddress
- user : user
- password : password
- idaddress : 1000
Request:
Get address list
Parameter | Description | Compulsory / Optional |
---|---|---|
class=user | Class requested: Class to which the request is made | Compulsory |
method=getaddresses | Class method requested: Method of the class to which the request is made | Compulsory |
user | User and e-mail of your Afilnet account | Compulsory |
password | Password of your Afilnet account | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
-
list
- id
- namelastname
- iscompany
- companyname
- documentid
- countrycode
- cityid
- cityname
- zipcode
- address
- verified
- addressverified
-
list
- error (if status=error), here you will receive the error code
Error codes:
Code | Description |
---|---|
MISSING_USER | User or email not included |
MISSING_PASSWORD | Password not included |
MISSING_CLASS | Class not included |
MISSING_METHOD | Method not included |
MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
INCORRECT_USER_PASSWORD | Incorrect user or password |
INCORRECT_CLASS | Incorrect class |
INCORRECT_METHOD | Incorrect method |
Parameters:
- class : user
- method : getaddresses
- user : user
- password : password
Request:
Get channel list
Parameter | Description | Compulsory / Optional |
---|---|---|
class=user | Class requested: Class to which the request is made | Compulsory |
method=getchannels | Class method requested: Method of the class to which the request is made | Compulsory |
user | User and e-mail of your Afilnet account | Compulsory |
password | Password of your Afilnet account | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
-
list
- channeltype
- channelname
- active
-
list
- error (if status=error), here you will receive the error code
Error codes:
Code | Description |
---|---|
MISSING_USER | User or email not included |
MISSING_PASSWORD | Password not included |
MISSING_CLASS | Class not included |
MISSING_METHOD | Method not included |
MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
INCORRECT_USER_PASSWORD | Incorrect user or password |
INCORRECT_CLASS | Incorrect class |
INCORRECT_METHOD | Incorrect method |
Parameters:
- class : user
- method : getchannels
- user : user
- password : password
Request:
Modify the status of a channel
Parameter | Description | Compulsory / Optional |
---|---|---|
class=user | Class requested: Class to which the request is made | Compulsory |
method=modifychannel | Class method requested: Method of the class to which the request is made | Compulsory |
user | User and e-mail of your Afilnet account | Compulsory |
password | Password of your Afilnet account | Compulsory |
channelname | Channel name | Compulsory |
active | (1) Enable or (0) Disable | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
Code | Description |
---|---|
MISSING_USER | User or email not included |
MISSING_PASSWORD | Password not included |
MISSING_CLASS | Class not included |
MISSING_METHOD | Method not included |
MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
INCORRECT_USER_PASSWORD | Incorrect user or password |
INCORRECT_CLASS | Incorrect class |
INCORRECT_METHOD | Incorrect method |
Parameters:
- class : user
- method : modifychannel
- user : user
- password : password
- channelname : sms
- active : 1
Request:
Tools that enhance our User Management API
SECURE API CONNECTION
Security tailored to your business
Configure your API connections, create new accesses and manage existing ones.
Filter all API accesses by IP, add or remove enabled IPs to guarantee the security of your accesses.
Keep track of all connections made, API used and connection dates / time
MULTIPLE APIs
Connectivity tailored to your business
We offer you multiple APIs to connect with us, we have an HTTP API, BASIC AUTH, SOAP and JWT Authentication so that you can connect with us the way you want.
Connect with any of the APIs in a secure, simple and centralized way . Afilnet API is perfect for your software.
API Logs
Get to know each request in detail
Thanks to our logs you will be able to review all the requests made and the corresponding response from our API, which will allow you to consult details when you need them.
The information you can consult is the following:
- Source IP of the request
- Date & Time of the request
- API & Method being called
- Parameters sent to the API
- API response
- metadata
Steps to use the API
Getting started with our user management API will take just a few minutes
Request your free trial
In order to use our API you must register as an Afilnet client. Afilnet registration will not take you more than 5 minutes.
Integrate the API
Integrate the functionality of our user management API that you want. If you have any questions, contact our team.
Get started with the API
The user management API is completely free. You will be able to use this API without any limitations.
Welcome to Afilnet!
Everything ready!, has managed to improve its communications with Afilnet. We are here to support our API when you need it