Download as pdf or txt
Download as pdf or txt
You are on page 1of 8

AMROD/ALTITUDE API V3

INTEGRATION REFERENCE
CONTENTS
API Urls ................................................................................................................................................... 3
Amrod ................................................................................................................................................. 3
Altitude ............................................................................................................................................... 3
Support ................................................................................................................................................... 3
amrod ................................................................................................................................................. 3
WARP Development – Amrod Contracted IT....................................................................................... 3
Amrod API / Feed Terms of Use .......................................................................................................... 3
Account and Registration ................................................................................................................ 3
Entity Level Acceptance .................................................................................................................. 4
Registration..................................................................................................................................... 4
Using Our APIs .................................................................................................................................... 4
Your End Users ................................................................................................................................ 4
Compliance with Law, Third Party Rights, and Other Amrod Terms of Service ............................... 4
Permitted Access ............................................................................................................................ 4
API Limitations................................................................................................................................ 4
Communication with Amrod ........................................................................................................... 5
Feedback ......................................................................................................................................... 5
Non-Exclusivity ............................................................................................................................... 5
Changes to the Amrod API Updates ................................................................................................ 5
Security ........................................................................................................................................... 5
Limitation of Liability ...................................................................................................................... 6
Termination .................................................................................................................................... 6
Authentication ........................................................................................................................................ 7
API Authentication .............................................................................................................................. 7
Faulty response codes ..................................................................................................................... 7
Headers ........................................................................................................................................... 7
Authorization ...................................................................................................................................... 7
Syntax ............................................................................................................................................. 7
X-AMROD-IMPERSONATE ............................................................................................................. 7
Endpoints................................................................................................................................................ 8
API documentation ............................................................................................................................. 8
Default access: ................................................................................................................................ 8
API URLS

AMROD

https://www.amrod.co.za/v3/api

ALTITUDE

https://www.altitudec.co.za/v3/api

SUPPORT

AMROD

• Contact Person: Moeketsi Morailane


• Email: Moeketsi@amrod.co.za
• Contact Person: Khesi Sepeng
• Email: Khesi@amrod.co.za

WARP DEVELOPMENT – AMROD CONTRACTED IT

WARP Development is not authorized to respond directly to the Amrod client base. Any
communication to WARP Development should be accompanied by threaded assistance request from
an authorized contact at Amrod (Amrod Director, Amrod Sales Admin, and Amrod Technical).

WARP Development is not subject to Amrod's response quotas, and a response should be received
within 48 hours.

Gert Martinson/ Darshan Sivacumaar (ITSupport@amrod.co.za)

AMROD API / FEED TERMS OF USE

By using our API, you are agreeing to the terms below. If there is a conflict between these terms and
additional terms applicable to a given API, the additional terms will control for that conflict.
Collectively, we refer to the terms below, any additional terms, terms within the accompanying API
documentation, and any applicable policies and guidelines as the "Terms."

You agree to comply with the Terms and that the Terms control your relationship with us.

Please read all the Terms carefully.

Under the Terms, "Amrod" means Amrod Corporate Solutions, with offices at Cnr Pretoria Main Road
and Beatty Road, Waterfall District, Woodmead, South Africa.

We may refer to "Amrod" as "we", "our", or "us" in the Terms.

ACCOUNT AND REGISTRATION


Accepting the Terms

You may not use the API and may not accept the Terms if (a) you are not a registered trade only legal
entity.

ENTITY LEVEL ACCEPTANCE


If you are using the APIs on behalf of an entity, you represent and warrant that you have authority to
bind that entity to the Terms and by accepting the Terms, you are doing so on behalf of that entity (and
all references to "you" in the Terms refer to that entity).

REGISTRATION
In order to access our API you will be required to provide certain information (such as identification or
contact details) as part of the registration process for the API, or as part of your continued use of the
API. Any registration information you give to Amrod will always be accurate and up to date and you'll
inform us promptly of any updates.

USING OUR APIS

YOUR END USERS


You will require your end-users to comply with (and not knowingly enable them to violate) applicable
law, regulation, and the Terms.

COMPLIANCE WITH LAW, THIRD PARTY RIGHTS, AND OTHER AMROD TERMS OF
SERVICE
You will comply with all applicable law, regulation, and third party rights (including without limitation
laws regarding the import or export of data or software, privacy, and local laws). You will not use the
API to encourage or promote illegal activity or violation of third party rights. You will not violate any
other terms of service with Amrod.

PERMITTED ACCESS
You will only access (or attempt to access) an API by the means described in the documentation of that
API.

If Amrod assigns your developer credentials (e.g. client IDs), you must use them with the applicable API.

You will not misrepresent or mask either your identity or your API Client's identity when using the API
or developer accounts.

API LIMITATIONS
Amrod sets and enforces limits on your use of the APIs (e.g. limiting the number of API requests that
you may make or the number of users you may serve), in our sole discretion. You agree to, and will not
attempt to circumvent, such limitations documented with the API. If you would like to use any API
beyond these limits, you must obtain Amrod's express consent (and Amrod may decline such request or
condition acceptance on your agreement to additional terms and/or charges for that use). To seek such
approval, contact the relevant Amrod's API team for information (We will need a contact number).

COMMUNICATION WITH AMROD


We may send you certain communications in connection with your use of the API. Please review the
applicable API documentation for information about opting out of certain types of communication.

FEEDBACK
If you provide feedback or suggestions about our API, then we (and those we allow) may use such
information without obligation to you.

NON-EXCLUSIVITY
The Terms are non-exclusive. You acknowledge that Amrod may develop products or services that may
compete with the API Clients or any other products or services.

CHANGES TO THE AMROD API UPDATES


You acknowledge that Amrod reserves the right to make updates to our API from time to time and at
our sole discretion.

• You must implement and use the most current version of the Amrod API and make any changes
to your Application that are required as a result of such update, at your sole cost and expense.
Updates may adversely affect the manner in which your Application accesses or communicates
with the Amrod API. Your continued access or use of the Amrod API following an update or
modification will constitute binding acceptance of the update.
• Access and Use

Amrod may choose to change or discontinue the availability of all or some the Amrod API at any time
for any reason without notice.

These changes may include removing some features or the requirements of fees from previous free
services. We may impose limits on features and services or restrict access to some or all of the Amrod
API.

Your continued use of the API following such changes will constitute binding acceptance of changes.

Note: Should we not say something about asking clients to test the beta version of our API?

SECURITY
You agree that Amrod may monitor the use of the API to ensure quality, improve services and verify
user compliance. You will not interfere with the monitoring. This monitoring may include Amrod
accessing your application in order to identify security issues.

Amrod may suspend access to the API without notice should we believe you are in violation of Terms.

LIMITATION OF LIABILITY
Amrod will not be liable for any loss of use, lost or inaccurate data, failure of security mechanisms,
interruption of business, cost of delay or any direct, indirect, inconsequential, special, exemplary,
punitive, or other liability related to the API or its use.

TERMINATION
Amrod may terminate your license to use the API at any time for any reason.

Any licenses contained in these T&C's will automatically terminate without notice if you fail to comply
with any provisions of these T&Cs.

You may not issue any public announcements regarding the use of the Amrod API or any information
that suggest a partnership with Amrod.

You may terminate the use of the API at any time by stopping to use the API.

Use of the API outside of South Africa is prohibited, failure to comply with this will result in automatic
termination of API services.

If you disagree with the with these T&Cs your only recourse is to not use the API.

On suspension or termination of access to the API you may lose access ton materials, information or
content provided by the Amrod.
AUTHENTICATION

API AUTHENTICATION

Amrod API uses a custom authentication provider based on BASIC authentication. The provider works
by identifying the client by means of tokens. These tokens are supplied in the header of every request.

FAULTY RESPONSE CODES

Code Reason
401 Authentication Failed. Missing or invalid Header
“Authorization”
403 Forbidden. Access with the token or Amrod
client impersonation account is not allowed.
500 SERVER ERROR

HEADERS

Name Description
Authorization Authentication header identifying the identity of the request. This
value is case sensitive.
X-AMROD-IMPERSONATE The Amrod account the request should be impersonating. This is used
for tracking purposes as well as pricing and other client specific data.

AUTHORIZATION

SYNTAX
Amrod type=”integrator”, token=”<identitytoken>”

X-AMROD-IMPERSONATE

SYNTAX
Amrod account number of the profile to load during this request.
ENDPOINTS

API DOCUMENTATION

Amrod API Endpoint documentation can be located from the URL below:

https://www.amrod.co.za/v3/swagger/ui/index#/

Access to some Endpoint might not be available depending on your individual token configuration.

DEFAULT ACCESS:
• Branding Positional Info
• Branding Calculation
• Branding Inclusive Details
• Account Profile Info
• Dashboard
o Active Orders, Credit, Reservations
• Stock Level
• System
o Supported Currencies (conversion estimation only, not actual sale pricing for regions)
o Amrod Branch Info (does not include updating of order’s destination branch)

You might also like