User Management API in SQL Server
Manage user information, know the balance you have in your account and manage your addresses.
Get account balance with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'user';
DECLARE @method varchar(500) = 'getbalance';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?class='+@class+'&method='+@method+'&user='+@user+'&password='+@password;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| 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 |
Add new address with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'user';
DECLARE @method varchar(500) = 'addaddress';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @namelastname varchar(500) = 'name+lastname';
DECLARE @iscompany varchar(500) = '1';
DECLARE @companyname varchar(500) = 'mycompany';
DECLARE @documentid varchar(500) = '123456789A';
DECLARE @countrycode varchar(500) = 'us';
DECLARE @cityid varchar(500) = '1';
DECLARE @cityname varchar(500) = 'town';
DECLARE @zipcode varchar(500) = '123456';
DECLARE @address varchar(500) = 'address';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&namelastname='+@namelastname+'&iscompany='+@iscompany+'&companyname='+@companyname+'&documentid='+@documentid+'&countrycode='+@countrycode+'&cityid='+@cityid+'&cityname='+@cityname+'&zipcode='+@zipcode+'&address='+@address;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| 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 |
Remove an address with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'user';
DECLARE @method varchar(500) = 'deleteaddress';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idaddress varchar(500) = '1000';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idaddress='+@idaddress;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| 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 |
Get the address list with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'user';
DECLARE @method varchar(500) = 'getaddresses';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| 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 |
Get channel list with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'user';
DECLARE @method varchar(500) = 'getchannels';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| 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 |
Modify the status of a channel with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'user';
DECLARE @method varchar(500) = 'modifychannel';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @channelname varchar(500) = 'sms';
DECLARE @active varchar(500) = '1';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&channelname='+@channelname+'&active='+@active;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| 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 |
Afilnet offers you methods to improve security when using our API with SQL Server, thanks to the possibility of creating accesses and the possibility of activating filtering by IP.
Which API for SQL Server should I use?
Discover the advantages and disadvantages of each of our APIs. Find out which API is best for your Software in SQL Server.
This API allows you to connect to us from SQL Server to send requests via HTTP GET requests. This request sends the parameters in the same URL as the request.
- HTTP GET is extremely simple to implement
- Information is sent unencrypted (passwords could be extracted from logs or cache)
- Maximum request of ~4000 characters
The POST request API allows you to connect to our API from SQL Server by sending request parameters via HTTP POST parameters. The information is sent independently of the URL.
- HTTP POST is simple to implement
- Information is sent encrypted
- There is no limit on the size of the request
- Medium security
The basic authentication API allows the use of GET and POST requests in SQL Server with an additional security layer, since in this case the username and password are sent in the header of the request.
- Basic authentication is easy to implement
- Access data is sent encrypted
- The size limit depends on the use of GET or POST
- Medium security
SOAP allows you to send requests in XML format with SQL Server, SOAP adds an extra layer of security to API requests.
- SOAP integration is more complex
- Information is sent encrypted
- There is no limit on the size of the request
- Medium / High security
Our JSON API allows you to send requests in JSON format with SQL Server, in addition this API adds the oAuth 2.0 protocol in the authentication that allows you to add an additional layer of security.
- JSON oAuth 2.0 integration is more complex
- Information is sent encrypted
- There is no limit on the size of the request
- High security
Connect SQL Server with our User API
01
Register as a client
In order to have access to the API you must be an Afilnet client. Registration will take a few minutes.
02
Request your free trial
Our company will offer you trial balance that will allow you to test with the API you need.
03
Integrate the API
Perform API integration using the programming language of your choice. If you have any questions or suggestions about the API, contact us
04
Welcome to Afilnet!
Everything ready!, has managed to improve its communications with Afilnet. We are here to support our API when you need it
Contact our team with any questions through the contact methods that we offer. Our team will try to offer you an immediate solution and will help you in the integration of our API in your Software.