|
|
| (3 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| | {{InDev}} | | {{InDev}} |
| | | | |
| − | = Pawn2ME API Calls =
| + | {{Pawn2ME:Development/APIv3}} |
| | | | |
| − | All calls require a store api key. That can be done by an admin via [https://accounts.xceldata.com/ accounts.xceldata.com]
| + | = Older Versions = |
| | | | |
| − | == /v1/authenticate/send ==
| + | * [[Pawn2ME:Development/APIv2|API v2]] |
| − | | + | * [[Pawn2ME:Development/APIv1|API v1]] |
| − | This endpoint is used to verify the api key. It will also return the name of the store.
| |
| − | | |
| − | POST -> https://api.pawn2me.com/v1/authenticate/send
| |
| − | | |
| − | <blockquote>{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93" }
| |
| − | </blockquote>
| |
| − | Result:
| |
| − | | |
| − | <blockquote>{ "success": true, "key": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93", "store": "DEMO 1 STORE A" }
| |
| − | </blockquote>
| |
| − | == /v1/customers/signup-user ==
| |
| − | | |
| − | In order to use Pawn2ME, customers must first verify their device by activating it, per store.
| |
| − | | |
| − | This endpoint tells the server to send an activation link to a specific sms/email address.
| |
| − | | |
| − | A customer cannot receive notices before activating.
| |
| − | | |
| − | POST -> https://api.pawn2me.com/v1/customers/signup-user
| |
| − | | |
| − | === Single Customers ===
| |
| − | | |
| − | <blockquote>{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93", "address-type": "sms", "address": "5551234567", "first-name": "Test", "last-name": "Testerson", "id": "D1234567", "language-type": "en" }
| |
| − | </blockquote>
| |
| − | Result:
| |
| − | | |
| − | <blockquote>{ "success": true, "id": "D1234567", "address": "5551234567", "address-type": "sms" }
| |
| − | </blockquote>
| |
| − | === Multiple Customers ===
| |
| − | | |
| − | <blockquote>{ "customers": [ { "address": "[mailto:test@test.com test@test.com]", "address-type": "email", "first-name": "TESTLA", "id": "D1234567", "language-type": "EN", "last-name": "TESTERFIELD" }, { "address": "5551234567", "address-type": "sms", "first-name": "TEST", "id": "D9876543", "language-type": "EN", "last-name": "TESTERSON" } ], "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93" }
| |
| − | </blockquote>
| |
| − | Result:
| |
| − | | |
| − | <blockquote>{ "success": true, "customers": [ { "success": true, "id": "D1234567", "address": "[mailto:test@test.com test@test.com]", "address-type": "email" }, { "success": true, "id": "D9876543", "address": "5551234567", "address-type": "sms" } ] }
| |
| − | </blockquote>
| |
| − | == /v1/customers/get-updates ==
| |
| − | | |
| − | This endpoint allows you to know which of your customers are activated or not.
| |
| − | | |
| − | Recording this information allows you to notify the teller that a user is signed up with Pawn2ME and with what account.
| |
| − | | |
| − | The user must have authorized their device to show up as activated. You will only see the activation status of people who signed up at your store.
| |
| − | | |
| − | POST -> https://api.pawn2me.com/v1/customers/get-updates
| |
| − | | |
| − | <blockquote>{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93" }
| |
| − | </blockquote>
| |
| − | Result:
| |
| − | | |
| − | <blockquote>{ "success": true, "updates": [ { "id": "D1111111", "added": "2018-02-06 18:06:21", "updated": "2018-02-06 18:14:32", "activated": true, "device": { "type": "sms", "address": "5551234567" } }, { "id": "D9999999", "added": "2018-02-07 23:10:02",
| |
| − | </blockquote>
| |
This article documents features that are still in development.
Information may change rapidly as the event progresses, or if requirements change. The last updates to this article may not reflect the most current information.
Pawn2ME Version 3 API Calls
All calls require a store api key. That can be done by an admin via accounts.xceldata.com
/v3/authenticate/send
This endpoint is used to verify the api key. It will also return the name of the store.
Note: There are no changes from v1/v2 as of 1/18/2019
POST -> https://api.pawn2me.com/v3/authenticate/send
{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93" }
Result:
{ "success": true, "key": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93", "store": "DEMO 1 STORE A" }
/v3/customers/signup-user
In order to use Pawn2ME, customers must first verify their device by activating it, per store.
This endpoint tells the server to send an activation link to a specific sms/email address.
A customer cannot receive notices before activating.
Note: There are no changes from v2 as of 1/18/2019
POST -> https://api.pawn2me.com/v3/customers/signup-user
{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93", "address-type": "sms", "address": "5551234567", "first-name": "Test", "last-name": "Testerson", "id": "D1234567", "language-type": "en", "language-type": "en", "country-code": "1" }
Result:
{ "success": true, "id": "D1234567", "address": "5551234567", "address-country-code": "1" }
/v3/customers/get-updates
This endpoint allows you to know which of your customers are activated or not.
Recording this information allows you to notify the teller that a user is signed up with Pawn2ME and with what account.
The user must have authorized their device to show up as activated. You will only see the activation status of people who signed up at your store.
Note: There are no changes from v2 as of 1/18/2019
POST -> https://api.pawn2me.com/v3/customers/get-updates
{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93" }
Result:
{ "success": true, "updates": [ { "id": "D1111111", "added": "2018-02-06 18:06:21", "updated": "2018-02-06 18:14:32", "activated": true, "device": { "type": "sms", "address": "5551234567" } }, { "id": "D9999999", "added": "2018-02-07 23:10:02",
/v3/notices/confirm-batch
In order to send a batch it must be confirmed.
This endpoint tells the server to actually allow sending notices to the previously submitted batch number.
Note: There are no changes from v1 as of 1/18/2019
POST -> /v3/notices/confirm-batch
{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93", "batch-no": "9" }
Result:
{ "success": true, "count": 58 }
Older Versions
