Forums › Forums › OroCRM › OroCRM – Programming Questions › REST API for Third Party Apps?
This topic contains 9 replies, has 4 voices, and was last updated by Bill Curtis 10 years ago.
Starting from March 1, 2020 the forum has been switched to the read-only mode. Please head to StackOverflow for support.
- CreatorTopic
- March 17, 2014 at 4:54 pm #24701
Are there plans to add a REST API so third party apps can access Oro resources? I’m new to Oro so this may exist, but not seeing any API key management in the UI.
Eg. GET http://www.myorosite.com/api/v1/contacts to grab a list of contacts
- CreatorTopic
- AuthorReplies
- March 18, 2014 at 9:26 am #24702
Hello Bill,
You can list every REST routes from Oro like this:
php app/console router:debug | grep api
For example, contacts REST routes are:
123456789101112131415161718oro_api_delete_contact DELETE ANY ANY /api/rest/{version}/contacts/{id}.{_format}oro_api_get_contact GET ANY ANY /api/rest/{version}/contacts/{id}.{_format}oro_api_get_contacts GET ANY ANY /api/rest/{version}/contacts.{_format}oro_api_post_contact POST ANY ANY /api/rest/{version}/contact.{_format}oro_api_put_contact PUT ANY ANY /api/rest/{version}/contacts/{id}.{_format}oro_api_delete_contactgroup DELETE ANY ANY /api/rest/{version}/contactgroups/{id}.{_format}oro_api_get_contactgroup GET ANY ANY /api/rest/{version}/contactgroups/{id}.{_format}oro_api_get_contactgroups GET ANY ANY /api/rest/{version}/contactgroups.{_format}oro_api_post_contactgroup POST ANY ANY /api/rest/{version}/contactgroup.{_format}oro_api_put_contactgroup PUT ANY ANY /api/rest/{version}/contactgroups/{id}.{_format}oro_api_delete_contact_address DELETE ANY ANY /api/rest/{version}/contacts/{contactId}/addresses/{addressId}.{_format}oro_api_get_contact_address GET ANY ANY /api/rest/{version}/contacts/{contactId}/addresses/{addressId}.{_format}oro_api_get_contact_address_by_type GET ANY ANY /api/rest/{version}/contacts/{contactId}/addresses/{typeName}/by/type.{_format}oro_api_get_contact_address_primary GET ANY ANY /api/rest/{version}/contacts/{contactId}/address/primary.{_format}oro_api_get_contact_addresses GET ANY ANY /api/rest/{version}/contacts/{contactId}/addresses.{_format}oro_api_get_contact_phone_primary GET ANY ANY /api/rest/{version}/contacts/{contactId}/phone/primary.{_format}oro_api_get_contact_phones GET ANY ANY /api/rest/{version}/contacts/{contactId}/phones.{_format}SYNOLIA – Lead Developer
March 18, 2014 at 9:41 am #24703Awesome – that makes sense.
I’m reading on other threads that the REST API Auth is WSSE.
The workflow I’m looking for is to paste an API Key into my external system, so it can pull Oro contacts/orders in. Typically I’ve seen this done with Basic or Bearer authentication. Is there a workflow you recommend for this type of API integration with Oro?
Thanks
March 18, 2014 at 9:47 am #24704I cannot respond to your request because I’m not part of the Oro Team :)
You’ll have to wait for one of them.
SYNOLIA – Lead Developer
March 18, 2014 at 9:50 am #24705Haha oh right on, well thanks for the help earlier!
Standing by for Team Oro.
March 18, 2014 at 6:56 pm #24706Also you can see all existing API on http://demo.orocrm.com/api/doc
March 19, 2014 at 4:48 pm #24707@Bill Curtis, thanks for bringing up this issue, current implementation requires regenerate WSSE header every hour and not allows to do this without server side command to be involved. It makes integration very complex and we’ll address this before our next release.
March 21, 2014 at 10:55 am #24708Hi Dima, thanks for the reply – looking forward to the next release for this feature :)
April 3, 2014 at 11:47 am #24709We release 1.0.0 two day ago and updated WSSE authentication in scope of the release. You can find more information in our documentation.
April 3, 2014 at 11:53 am #24710Good stuff – thanks Dima
- AuthorReplies
The forum ‘OroCRM – Programming Questions’ is closed to new topics and replies.