Get started
To use the EValue APIs you first need to create an account within our API portal
-
Click the 'Sign-up' link in the top right of the API Portal home page.
-
Enter details to create your account, and click 'Sign Up'.
-
Sign in and start using the portal.
Using the API Portal for the first time
Generating access keys
Before you can begin sending requests to the APIs, you will need to activate the application and generate the necessary access keys (production and/or sandbox).
-
Click on the 'Applications' link in the navigation menu in the upper left of the portal.
The resulting page shows the default application, 'DefaultApplication' (and any other applications you have created within the portal).
-
Click on the DefaultApplication under the 'Name' column to be taken to its management page.
-
In order to create an access token for your application, it must have a 'Consumer Key' and 'Consumer Secret' generated for it by clicking 'Generate keys' in the 'Production Keys' or 'Sandbox Keys' tabs of the management page for your application. Doing this will also generate your first access token for your application, which by default has a validity period of 60 minutes (or 3600 seconds). You can change this validity period, if you wish the key to be available for longer or shorter than 60 minutes.
Please note: the Production and Sandbox endpoints are different environments: the Production endpoint is EValue's production environment; the Sandbox endpoint is EValue's pre-production environment. Only the Production environment will return a valid response, therefore calls to this environment are currently included in any credit quota, in line with your chosen Payment Plan. The Sandbox environment will return dummy responses and therefore calls to this environment will not be included in any limited credit quota.
Subscribe to individual APIs
Now that you have a valid access token for your application, you are ready to subscribe to an API.
-
Navigating to the 'APIS' section of the portal using the link in the navigation menu.
-
Click on the API to which you wish to subscribe. The resulting page contains information (including links to specific documentation) on the API you have selected, in addition to an 'API Console' that you can use to try-out the API.
Note: If you click on the 'API Console' tab, you will see a notification alerting you that you must first subscribe to the API before you can use it.
-
To subscribe, click the 'Subscribe' button in the top right of the page. You should see a 'Subscription Successful' dialog box apear confirming that you are now subscribed to the API.
Once subscribed, you will be able to see your access key has been added as a request header at the top of the 'API Console' within your chosen API.
Using the API Console
You can now use the API Console to interact with the API.
-
Expand the operation you are looking to request.
-
Please note that for each operation listed under the API, you can populate an example request by clicking on the JSON displayed under 'Example Value' in the 'Data Type' column. This example json can then be edited manually to send a specific request that you are interested in.
-
To send the request, click 'Try it out'.
-
The response will be shown beneath it.
Troubleshooting the APIs
Should you experience any issues or technical difficulties with our APIs, please see the FAQ section of the Developer Portal https://api.ev.uk/faqs.php. This will be frequently updated and maintained in order to provide the best self-support service.
Alternatively, we understand that there will be questions outside of the FAQ coverage and we therefore have a dedicated Support team at apiteam@ev.uk.
Please note:
Content support is available only to Subscribed Users; as the Sandbox APIs returns dummy responses, we are unable to provide any support relating to queries on the content of the APIs themselves. However both Subscribed and non-Subscribed Users have access to Technical, Billing and Account Management support services.
