groom12.md

Grooming Notes

---

Dynamic Generated Transaction API documentation

• Promote Self Serve Token best practices
• Update transaction_id information

Acceptance Criteria

---

Required to be Updated

Network Level Accounts Advertiser Level Accounts Affiliate Level Accounts

URL Section Update

Under some Network level accounts, the url still shows ringrevenue.com instead of invoca.net.

Authentication Section Update

The Current API uses HTTP Basic Authentication.

The authentication username is your email address and password is your API key. Visit your user profile page to get an API key. You must be a super user to get an API key and to use the API.

Becomes:

The API uses OAuth Authentication to authenticate that access is allowed. The self-serve API token can be created in Manage API Credentials page. See Manage API Credentials for instructions. You must be a super user to get an API key and to use the API. Where Manage API Credentials should link to http://invoca.uservoice.com/knowledgebase/articles/397341-manage-api-credentials

Query Parameters Update

Need to expose oauth_token?

Example Section Update

Should be updated to

For example, if you have this API token: YbcFHZ38FNfptfZMB0RZ6dk9dOJCaCfU

Here is an example using curl to get the next 20 transactions that occurred after transaction id 30853-01158:

curl -k https://ringpartner.ringrevenue.com/api/2014-05-23/networks/transactions/398.csv?limit=20&start_after_transaction_id=30853-01158&oauth_token=YbcFHZ38FNfptfZMB0RZ6dk9dOJCaCfU

The -k option asks curl to not bother checking the SSL certificate authority chain as that requires extra configuration.

Code References

• Routing Requests
• Transaction API View