2. How to connect to API directly through your
Organization account. Api is a contract. A
promise to perform described services when
asked in specific ways.
API access is the process of ensuring that calls
with authenticated logins are able to access the
APIs. API products are also a good way to control
access to a specific bundle of resources.
Apigee API management solution empowers you
to allow or deny access to your APIs, by specific
IP addresses.
Since API products are the central mechanism for
authorization and access control to your APIs,
Apigee helps provision API keys for them.
5. The following are the prerequisites to use
Reports API.
User account
Auth Token
◦ Generating Auth Token
◦ Managing Auth Tokens
Reporting Database
6. There are four steps that are required to
access the API”s
1. Create or Purchase a valid digital signing
certificate.
2. Sign into the Developer Portal as an admin
user and get a set of credentials.
3. Use the credentials you receive to create a
JSON Web Token (JWT).
4. Use the JWT token to obtain the access
token that you must pass to every API call.
7. User Account
Users should have a valid login email address to use the API.
Auth Token
Authentication Token, here after referred as Auth Token, is a unique token that
authenticates the user to access the Account. This is a user-specific and
permanent token that need to be passed along with every Reports API request.
Generating Auth Token
Users can generate a Auth Token using one of the following mode. You can
generate it just once and use it for all your API calls.
Browser Mode
API Mode
Browser Mode
To generate Auth Token from your Browser, follow the steps given below.
Login to your account.
Now open a new tab in the same browser and then access the URL below.
https://accounts.com/apiauthtoken/create?SCOPE=Reports/reportsapi
8. Sample Response:
The following is a sample response for a Auth
Token request.
#
#Wed Jun 29 03:07:33 PST 2013
AUTHTOKEN=bad18eba1ff45jk7858b8ae88a
77fa30
RESULT=TRUE
#COMME
NT
Auth Token generated date.
AUTHTO
KEN
The permanent Auth Token (Alpha numeric value)
generated for API access.
RESULT Value is TRUE if the Auth Token is generated
successfully.
Response Details:
9. API Mode
To generate Auth Token using API mode,
send an HTTPS POST request to Accounts
using the following URL format.
URL Format:
https://accounts.com/apiauthtoken/nb/creat
e?SCOPE=Reports/reportsapi
Mandatory POST Parameters to be passed
along with this URL are:
10. Parameter Description
EMAIL_ID Specify your Login Email Address
PASSWORD Specify your Reports Password
(Note: You have to provide Application
Specific Password if you are using
Two Factor Authentications. Read the Note
below to know how to generate this)
11. Note for users using Two Factor Authentication:
If you have enabled Two Factor Authentication (TFA)
for your Account, then you need to specify
the Application Specific Password, instead of your
Reports account password, to generate the Auth
Token.
The following are the steps to generate an
Application Specific Password for your Account.
Login into Account.
Two Factor Authentications. The Two Factor
Authentication section in the Settings page will open.
Click Manage Application Specific Passwords button.