Visit the eWay-CRM website and sign up for a free trial.
Fork our Postman collection.
Ask our support to generate ClientID / ClientSecret for your OAuth user flow (redirect URL is required). Or use our test service:
- WS URL: https://free.eway-crm.com/31994
- UserName: api
- Password: ApiTrial@eWay-CRM
Note
See How to find Web Service URL. For production use we recommend to see How to create a new user just for API integration. Also make sure the user has enough permissions for the required operations.
Fill in your details in the Postman Variables tab:
Go to Login method and inside Auth tab click Get New Access Token. While you login use the same user name as you previously specified in Postman Variables.
As soon as you have Access Token click Send to create new SID (Session ID).
With a session being generated you can start calling other methods eg. SaveJournal to create a new Journal in eWay-CRM.
Access Tokens are used to create a new session. Their lifetime is by default 1 hour.
Session lifetime is 20 minutes. Session lifetime gets extended with each API call, but after 24 hours it is invalidated.
Refresh Tokens are valid for 15 days. They can generate new Access Tokens. When a new Access Token is generated, Refresh Token lifetime gets extended.
Postman collection does contain all available methods. But you can use Swagger Documentation to view all available API methods.
It might be useful to look at eWay-CRM Database Schema.
Also see FolderNames for list of supported modules in eWay-CRM.
See Project Team for methods managing a project's team members, their roles and the project manager.
Depending on the technology you use you can pick one of our libraries.
.NET developers may download our NuGet package and start coding.
dotnet add package eWayCRM.API
For basic samples in C# go to csharp-lib repository.
JavaScript developers may leverage @eway-crm/connector.
npm i @eway-crm/connector
Even thought not complete, PHP developers may include eway.class.php.
// Load API
require_once "eway.class.php";
// Create connector
$connector = new eWayConnector('https://free.eway-crm.com/31994', 'api', 'ApiTrial@eWay-CRM');
Yes, API for custom development is available in Contacts & Companies (Standard).
When eWay-CRM uses Azure Auth, OAuth 2.0 is required for eWay-CRM API.
See a full demo app: https://github.com/eway-crm/eway-crm-oauth-demo
Currently only Authorization Code flows are supported (user is involved). User needs to login to get RefreshToken which is then used by the application on the backend.
- Methods: GetLastItemChangeId, GetBaseItemChangeId, GetItemChangeIdentifiers, GetChangedItems
- Sample: https://github.com/eway-crm/php-lib/blob/master/Examples/ChangesOnContacts/README.md
- Methods: SaveBinaryAttachment, SaveDocument
- Sample: https://github.com/eway-crm/php-lib/tree/master/Examples/CreateTaskWithDocument
- Method: SaveProject
- Sample: https://github.com/eway-crm/php-lib/tree/master/Examples/ChangeProjectStatus
- Method: SaveRelation
- Sample: https://github.com/eway-crm/php-lib/tree/master/Examples/LinkExistingItem
New eWay-CRM version upgrades may introduce some Breaking Changes. Please read them carefully.
For general API question you may raise issues in this repository. If you use one of our libraries post the questions there: