Introduc on to Redpack API 3

No Responsibility Disclaimer 4
Technical Standards 5
Requirements 6
Redpack Web Services 7
¿How to register on Redpack API portal? 9
Sign In 12
Forgo en Password 13
¿How to view API documenta on? 14
SOAP Web Services 14
SOAP Services General Request 14
QA & Produc on Environments 15
REST Web Services 16
¿How to get permissions in PROD? 18
Sign Out 20
Liabili es 20
Maintenance 21
Service level 21
QA environment 21
PROD environment 21
Contact Us 22
Redpack API is part of the Redpack Technology Solutions Portfolio, it is
designed to perform information exchange interfaces and integrate
capabilities from Redpack systems to your website, e-commerce portal, or
your company's applications, regardless of the platform on which they are
developed.

The solutions offered on this site are designed to be incorporated in

different situations and are focused on the specific needs of each customer,
from those who have sporadic shipments, to customers who handle
thousands of shipments.

This manual explains the features of the Redpack API portal, access
requirements, the content that is available and that can be consulted within
it, a set of Web services exposed with a brief description of the published
methods and how to access the documentation, all in a friendly environment
so that you feel comfortable using the portal and easily obtain the solution
to your needs.

3
No Responsibility Disclaimer

This manual is intended for developers who are familiar with consuming Web services over SOAP or
REST protocols, it does not contain technical instructions or explain step by step how consumption
should be performed using programming languages, assumes that the developer has the knowledge
to integrate web services into their platforms, so the consumer is solely responsible for integrating
within their software.

4
Technical Standards

The development required for the implementation of the Web services exposed by Redpack
requires the knowledge of consumption and a set of technical standards, such as the following:

• Web Services Protocol Stack: Is a stack of computer networking protocols that is used to
define, locate, implement, and make Web services interact with each other.

• XML (Extensible Markup Language): Defines a set of rules for encoding documents in a
standard format that is both human-readable and machine-readable.

• SOAP (Simple Object Access Protocol): Is a messaging protocol specification for exchanging
structured information in the implementation of Web services, allows developers to invoke
processes running on disparate operating systems to authenticate, authorize, and
communicate using XML.

• WSDL (Web Services Description Language): Is an XML-based interface description

language that is used for describing the functionality offered by a Web service.

• UDDI (Universal Description, Discovery and Integration): Is an open industry initiative,

sponsored by the OASIS, for enabling businesses to publish service listings and discover each
other, and to define how the services or software applications interact over the Internet.

• WS-Security (Web Service Security): Is an extension to SOAP to apply security to Web

services. The protocol specifies how integrity and confidentiality can be enforced on
messages and allows the communication of various security token formats. Its main focus
is the use of XML Signature and XML Encryption to provide end-to-end security.

• REST (Representational State Transfer): Is a software architectural style that defines a set
of constraints to be used for creating Web services. Web services that conform to the REST
architectural style, called RESTful Web services, provide interoperability between computer
systems on the internet, allow the requesting systems to access and manipulate textual
representations of Web resources by using a uniform and predefined set
of stateless operations. In a RESTful Web service, requests made to a resource's URI will
elicit a response with a payload formatted in HTML, XML, JSON, or some other format. The
response can confirm that some alteration has been made to the resource state, and the
response can provide hypertext links to other related resources. When HTTP is used, the
operations available are GET, POST, PUT, PATCH, DELETE, CONNECT, OPTIONS and TRACE.

• HTTPS (Hypertext Transfer Protocol Secure): is an extension of the Hypertext Transfer

Protocol (HTTP). It is used for secure communication over a computer network, and is
widely used on the Internet. In HTTPS, the communication protocol is encrypted
using Transport Layer Security (TLS) or, formerly, Secure Sockets Layer (SSL).

5
Requirements

The following are the requirements for using the Redpack API portal:

• Register on the website https://api.redpack.com.mx to obtain your user account and

credentials to perform the consumption.
• Be registered as a Redpack customer.
• Homologation of API account and Redpack Customer account through the ID and the Radar
client key to which the guides are sold for consumption from the API.
• Execution permissions in QA environment, which are automatically granted when
requested.
• Apply for permits in a productive environment once the consumption has been developed.

For a better viewing experience of the website content, it is recommended to use the following
browsers:

• Google Chrome.
NOTE • Mozilla Firefox.
• Microsoft Edge.

6
Redpack Web Services

The Web services provided by Redpack are the following:

1. Service Type Catalog: This catalog refers to the type of service covered by the guide,
defining the type of service as Express or Ecoexpress.

2. Delivery Type Catalog: This catalog refers to the type of delivery of the shipment, defines
whether the delivery will be made at Residential location or Redpack Store depending on
the need and coverage of the service.

3. Shipping Type Catalog: This catalog refers to the format of the physical shipment, defines
whether the packaging is Envelope or Box.

4. Tracking by Number: It allows you to get a complete tracking of a shipment through the
tracking number.

5. Documentation: Through the consumption of this service, customers receives as the main
response the image byte array in PDF format to print the label, commonly called a guide, it
is possible to choose between a 4 x 6-inch printing format or a format in letter size (bond
paper) or in special cases, obtain the image to print it in its own format. In all cases, general
information on consumption must be received. Recommended for high consumption
customers, with defined volume and weight and specific projects that operate from a
warehouse.

6. Automatic Documentation: In this process, unlike the Documentation web service, the user
will obtain the guide's folio when consuming, since the assigned folios are stored in a table
in our database.

7. Nationwide Coverge: It allows to obtain the types of coverage from a source postal code to
a destination postal code.

8. National Quote: Calculate the estimated shipping costs based on details such as origin,
destination, packaging and weight.

9. Create Shipping Label: This service receives a guide and generates the shipping label for the
package.

7
10. Tracking by Reference: It allows to obtain the complete follow-up of a shipment through a
reference and customer key.

11. Postal Code Lookup: Allows you to get the towns within a zip code, as well as the city and
state to which it belongs.

12. Pickup Request: It allows to request a shipping pickup at the address specified by the client.

13. Type Mail Catalog: In this catalog you will get the defined statuses for which notification
emails can be generated.

14. States Catalog: This Web service get the list of Mexican states.

15. Send Mail Notification: It allows you to configure the sending of notification emails in
defined status of the shipment.

16. Calculate Insurance Rates: Get the amount to pay for the insurance.

17. Ensure Shipment: It allows you to insure a shipment and obtain an electronic insurance folio
related to the guide number that covers the service.

18. Test Delivery: Obtains the signature image of the reception of a shipment.

8
¿How to register on Redpack API portal?

If you are a new user and you do not have an account, you must register and obtain the access
credentials to be able to use the API portal resources.

1. Go to the website https://api.redpack.com.mx and click on [Register Now].

Fig 1. Home page

2. Provide information about yourself on the Registration form:

a. Username
b. Password
c. Email
d. Name
e. Last Name
f. Second Last Name
g. Company
h. Street
i. Number
j. Country
k. City
l. Zip Code
m. Telephone number

9
 Fig 2. Registration form

3. Once you have filled in all information, click on [Sign Up].

API portal validates your information and will send you an email to the address provided to verify
the account and complete the registration process.

10
 Fig 3. Registration in process

If you have not received the confirmation email click on the link below the [Register Now] button.
From the Resend email validation popup, enter your username and click [Send].
TIP

Fig 4. Resend email validation

11
Sign In

After completing the registration process successfully, you can sing in.

4. From the home page, click on [Sign in], then enter your username and password.

Fig 5. Sign In popup

If you still don’t have your Redpack API user account, from Sign in popup it is possible to register, click
on [Do not have an account? Register Now!].
TIP

12
 Forgotten Password

If you forget your password and cannot access your Redpack API user account, you can use the
“Forgotten Password” feature to re-send your password to the email address associated to your
user account:

1. From Sign in popup, click Forgot your password?

2. Enter your username and email address previously registered.

Fig 6. Recover Password

Clicking [Send] will display an Update password popup.

3. Enter your new password and confirmation, click [Send].

Fig 7. Update password popup

In this section we have demonstrated how to access to Redpack API portal using the login form. We have
also established how to use the forgotten password functionality to retrieve a user’s password in the event
of the password being lost or forgotten.
NOTE

13
¿How to view API documentation?

SOAP Web Services

The SOAP Web services is the first page that is displayed to you post-authentication.

1. To wiew the list of all exposed services, click on “Servicios Web del Redpack API” option in
the Groups section.
2. Or, enter a Web service name or search criteria, then click on [Search].

Fig 8. SOAP Web services page

SOAP Services General Request

The initial request is based on the access authorization which is integrated by the credentials
obtained on the API portal.

PIN: Unique and unrepeatable character string assigned to the user.

ID: User ID number.
Guides: An array of guide objects (in case it is required).

14
 Field Name Type Required Description
This field defines the environment to
PIN String ü which the consumption is aimed, as
well as the user´s access key.
ID Integer ü User ID number.
An array of guide objects according
Guides Array Optional to the specifications of the service to
be consumed.

QA & Production Environments

Our WSDL redirects to 2 possible environments, Development and Production. When requesting
consumption permits in the portal, permission is automatically obtained to the environment called
QA, this is connected to a non-productive database in which development and consumption tests
can be performed.

To perform the addressing, the prefix of the environment to be consumed must be

placed before the PIN label, leaving a blank between it and the PIN string.
NOTE

Once the development is completed and validated, the connection change to the productive
environment called PROD can be made, access must be requested through the portal or by email so
that the Redpack technological solutions area grants the privileges.

Development
<PIN>QA gy1AfZeAQdJKIOdl64UDkuy70Ft1123</PIN>

Production
<PIN>PROD gy1AfZeAQdJKIOdl64UDkuy70Ft1J123</PIN

WSDL
http://ws.redpack.com.mx/RedpackAPI_WS/services/RedpackWS?wsdl

15
REST Web Services

To view the documentation for REST Web services do the following:

1. Select REST Web services from the sidebar.

2. Enter a Web service name or search criteria, then click on [Search].

Fig 9. REST Web services page

To make it easier to search for REST Web services, they are grouped by categories. Select one of the
groups to access the list of services it contains.
TIP

16
Search results will be displayed as a list.

3. Select the Web service you are interested in and click on the URL to view the
documentation.

Fig 10. REST Web service URL

A new tab will open in your browser displaying the information of the selected REST Web service in
Swagger UI.

Fig 11. Swagger UI

17
¿How to get permissions in PROD?

To get permits to the productive environment it is necessary to request them through the portal,
this can be done from the service search screen.

1. From the sidebar, choose the type of Web service you want to search for.
2. Enter the Web service name, then click on [Search].

Fig 12. REST Web services page

To make it easier to search for REST Web services, they are grouped by categories. Select one of the
groups to access the list of services it contains.
TIP

18
API portal will return records that match the search criteria entered.

3. Choose the Web service you need, then click on [Ask for permission].

Fig 13. Web services search results

Once you have made the request, a confirmation popup will be displayed.

To be able to use the services, you must wait for authorization from the API portal administrator.

Fig 14. Requested Web service confirmation popup

19
Sign Out

To log out of the API portal, click [Sign Out] on the sidebar, then confirm you want to leave.

Fig 15. Sign out button and confirmation popup

Liabilities

Customer

• Make responsible use of the Redpack API platform.

• Immediately report any error or incident that occurs.
• Maintain active communication with the information technology area in any situation, as
well as with your sales advisor.

Information Technology Redpack

• Maintain correct operation and availability of the Redpack API.

• Solve errors that occur within the platform.
• Maintain active communication with the client.

20
Maintenance
For the QA environment, on Sundays of each week maintenance is performed on the database, so
the service could be disabled from 6 to 11 pm, momentarily stopping operations.

Service level

QA environment
Percentage
Objective Availability
rate
Monday to Saturday 24 hours
Web services availability Sunday 19 hours 96.3%
Not available from 6 to 11 pm
Monday to Saturday 24 hours
Maintain the correct performance of web
Sunday 19 hours 96.3%
services
Not available from 6 to 11 pm
Monday to Friday
Analysis and troubleshooting 98.3%
9 am to 6 pm

PROD environment
Percentage
Objective Availability
rate

Web services availability Monday to Sunday 24 hours 99.99%

Maintain the correct performance of web

Monday to Sunday 24 hours 99.99%
services

Monday to Friday
Analysis and troubleshooting 98.3%
9 am to 6 pm

21
Contact Us
If you have any question or suggestion send us an email, it will be a pleasure to assist you:

• [email protected]
• [email protected]

From the API portal by clicking [Contact us] on sidebar.

Need help?

Any questions or comments please contact us

[email protected]

Fig 16. Contact Us popup

22