Skip to main content

Checklist for Technical Analysis of an API

IDCategoryMandatory CategoryCheckpointDetailsMandatory CheckpointResultComments
DOC-01DocumentationMandatoryVerify completenessEnsure documentation is complete and up-to-date.Mandatory✅ / ❌Comment if needed
DOC-02Endpoint informationVerify clear information about the available endpoints.Mandatory
DOC-03Validate examplesConfirm that the documentation includes clear examples of requests and responses.Highly recommended
DOC-04Review error codesReview details provided about error codes.Mandatory
AUT-01Authentication and AuthorizationMandatoryConfirm authentication typeConfirm the type of authentication required (e.g., OAuth, API Key, etc.).Mandatory
AUT-02Test authentication flowEnsure the authentication flow works as expected.Mandatory
AUT-03Verify authorization mechanismsCheck authorization mechanisms and access control for different user roles.Recommended
FUN-01FunctionalityMandatoryEndpoint testingTest each endpoint with various data sets to check correct responses and error handling.Mandatory
FUN-02
FUN-03Business logic validationValidate the underlying business logic for consistency and accuracy. Minimum shopping flow (search, quote?, book)Mandatory
PER-01PerformanceMandatoryEvaluate response timesAssess API response times to ensure they meet performance requirements.Mandatory
PER-02Scalability testingPerform load tests to review the API's scalability, if applicable.Mandatory
PAY-01Payment TypesMandatoryVerify compatible payments typesCheck if at least one of these payment types is compatible: MERCHANT, DIRECT, CARD_BOOKING or CARD_CHECKIN_IN.Mandatory
CNP-01Cancellation PoliciesMandatoryIncludes start date, end date, penalty amount and penalty typeVerify whether the API provides: a cancellation deadline, penalty amount and penalty type (amount, percentage or number of nights).Mandatory
CNP-02Refundability IndicatorConfirm whether the cancellation policy includes an explicit field or flag indicating whether the option/room is refundable.Recommended
CNP-03Special policies (No-show, In-stay Cancellation, ...)Check if the API indicates special types of policies.Mandatory
CNP-04Mapping DifficultyClassify the complexity of mapping the cancellation policies to TravelgateX's model:• 🟢 (Green): Direct entity mapping****• 🟡 (Yellow): Requires intermediate logic (e.g., uncommon date formats, policy identifiers, cross-referenced calculations)****• 🔴 (Red): Cannot be mapped (e.g., free-text descriptions without structure)Mandatory
AVAI-01AvailabilityMandatoryMust be able to search by list of hotelsMandatory
AVAI-02Return rooms or options. Requires combinatory?Combinatory must be done by TG or not.Mandatory
AVAI-03An option/room must have a code and a description of the room and priceMandatory
AVAI-04Return policies in availabilityRecommended
AVAI-05An option/room must have a defined meal planotherwise we will assume room onlyHighly recommended
AVAI-06Must be able to uniquely identify an optionMandatory
AVAI-07The provider's API must be for accommodations for 1 checkin daynot packages, last-minute offers, checkin by hours...Mandatory
QUO-01QuoteNot mandatory if there is a second availability that includes all necessary informationPriceMandatory
QUO-02PoliciesMandatory
QUO-03RemarksRecommended
QUO-04If expiring, must be able to detect the expiration timeMandatory
BOO-01BookingMandatoryReservation statusMandatory
BOO-02PriceHighly recommended
CNX-01CancellationHighly recommendedReservation statusMandatory
CNX-02Amount to be paid (cancel penalty)Highly recommended
CHB-01CheckBookingsByReferenceHighly recommendedReservation statusMandatory
CHBD-01CheckBookingsByDateRecommendedReservation statusMandatory
HLIS-01HotelListMandatoryHotel codeMandatory
HIN-01HotelInfoHighly recommendedHotel code, name, address, country, geocoding (lat,long)Mandatory
HIN-02Hotel category, descriptions, images, amenitiesRecommended
CAT-01CategoriesHighly recommendedCategory code and descriptionNot having this call would force Travelgate to list hotels as NC, lowering their competitivenessMandatory
MEA-01MealplansHighly recommendedNot returning meal plans in availability lowers the competitiveness of the product.Mandatory
DES-01DestinationsRecommendedCode and name of the provider's destination treeMandatory
ROO-01RoomListOptionalCode and nameIt may be mandatory for some buyersMandatory