Cypress: Where does the authentication token go for an API request?

Question

I am trying to request data through an API that requires authentification. I have the token and I know how to implement it using a manual tool such as postman...

How do I format the authentication using Cypress?

    it('GET - read', () => {
    cy.request({
        method: 'GET',
        url: 'https://mailtrap.io/api/v1/inboxes/123/messages?page=1&last_id=&useremail',
        headers: {
            Key: 'Api-Token',
            Value: '1234'
        }
    })
})

})

Response:

The response we got was:

Status: 401 - Unauthorized

Answer 1

As per the Mailtrap documentation , sending an header Api-Token: {api_token} should send authenticated requests. You can write:

cy.request({
    method: 'GET',
    url: 'https://mailtrap.io/api/v1/inboxes/123/messages?page=1&last_id=&useremail',
    headers: {
        'Api-Token': 'Your Token value' //Replace with real token
    },
    failOnStatusCode: false
}).then((res) => {
    expect(res.status).to.equal(200) //Replace with releveant 2xx response code
})