API

[TLALD11]

How to activate the Postal API? If you access the following https:///api/v1/messages you will receive a message that the page is not available. Is ther something to do?

[willpower232]

It doesn't work like a web page in a browser, you have to at least supply a API key header.

The docs link to the API docs so have a look at https://apiv1.postalserver.io/authenticators/server.html and then have a look at some of the other pages on that site for more information.

Depending on your programming language, you may wish to make use of a client library and some examples are linked from the main docs https://docs.postalserver.io/developer/client-libraries

[TLALD11]

Hello, i know. I also tried it with postal. URL and bearer Token. But response was the same. Is there something i have to configure in postal Mailserver-Server? I saw an entry in another discussion board about an entry in postal.yaml to enable the api?!

[willpower232]

For your reference, the API is not a separate entity to enable and disable, it is always on so if someone wanted to block it, they would have to at the caddy/nginx/whatever level instead.

[TLALD11]

here is my test with postal. i also tried it out with http and https and in php and there is the same.

The bearer token is the api token from the mailserver i have added in postal.

[TLALD11]

ok i found out, that i can not use bearer token. I use now the api key in headers config in postal and the api gives me the response, when api token was not valid and with enpoint /api/v1/messages/message i have to find out how i can add the id of the mail message.

[willpower232]

I believe you were sending the ID the right way but it was the wrong type so Postal told you it was missing.

[TLALD11]

ok, but am i right to use id-Field from Postal db table messages

[willpower232]

Yes, you got it. The regular id field, not the message_id.

[TLALD11]

i will try it tomorrow again, but i tried it without success

[willpower232]

Are you using an API key that belongs to the same Postal server/database? (The wording is a little confusing but if the API key and the message you're looking for are completely separate then it won't work).

[TLALD11]

hello, i do not know what i am doing wrong.

Now i have checked it and i use the correct API Token

And i also checked the message id in database which was send through this mailserver

But i got always the message : "message": "id parameter is required but is missing"

If i change the way to send the id like : api/v1/messages/message/7045335 i got

[willpower232]

Ah okay I misunderstood how this API works sorry.

You have to POST some JSON to it, for example

{"id":5679,"_expansions":true}

[TLALD11]

ohh thats great. it works

Thank you very much