Content-Type: application/json; charset=UTF-8;
                

                        
Authorization: api-key YiuyotGtRNDXik56lgq6
Content-Type: application/json; charset=UTF-8
                

                        
POST https://api.ekopost.se/auth
Authorization: Basic dXNlcm5gaGO6cGFzc3dvctE=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
  "access_token": "INKJ8ABgVeNIcp9MsuTIXO8QJtBiFE677h2hgcB1USVIY8KadBJ_faNrdKulFs",
  "token_type": "bearer",
  "expires_in": 28800
}
                

                        
Authorization: Bearer INKJ8ABgVeNIcp9MsuTIXO8QJtBiFE677h2hgcB1USVIY8KadBJ_faNrdKulFs
Content-Type: application/json; charset=UTF-8
                

                        
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
POST /campaigns HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "name": "Invoice March 2015",
    "output_date": "2025-06-01T12:00:00",
    "cost_center": "Finance Office"
}
                

                        
POST /campaigns HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
  "id": "1a8f635b-dd23-b283-89c2-9c71cfed7278",
  "output_date": "2025-05-19T13:06:49.1158269Z",
  "cost_center": "Finance Office",
  "envelope_count": 0,
  "state": "opened",
  "state_changed_at": "2025-05-19T13:06:49.1158269Z",
  "created_at": "2025-05-19T13:06:49.1158269Z",
  "name": "Invoice March 2015",
  "signing": false,
  "replymail": false
}
                

                        
POST /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/close HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
                

                        
POST /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/cancel HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
                

                        
GET /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
    "id": "4ebeab48-ee03-474f-bc79-c6db082c2bad",
    "name": "Invoice March 2015",
    "output_date": "2015-01-01T12:00:00",
    "cost_center": "Finance Office",
    "envelope_count": 1,
    "state": "opened",
    "state_changed_at": "2015-01-01T12:00:00",
    "created_at": "2015-01-01T12:00:00" 
}
                

                        
GET /campaigns?start={start}&stop={stop}&name={name}&state={state} HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
[{
    "id": "4ebeab48-ee03-474f-bc79-c6db082c2bad",
    "name": "Invoice March 2015",
    "output_date": "2015-01-01T12:00:00",
    "cost_center": "Finance Office",
    "envelope_count": 1,
    "state": "opened",
    "state_changed_at": "2015-01-01T12:00:00",
    "created_at": "2015-01-01T12:00:00" 
}]
                

                        
POST /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/envelopes HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "name": "Invoice 9923891",
    "address": null,
    "postage": "priority",
    "plex": "simplex",
    "color": true
}
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
    "id": "f6aa0f0a-4514-46e5-be2c-539278a58e70",
    "name": "Invoice 9923891",
    "address": {
        "$type": "postal",
        "name": [
            "Company Inc.",
            "c/o John Doe"
        ],
        "street": [
            "Street no. 37"
        ],
            "postal_code": "65421",
            "city": "Gothenburg",
            "country": "SE",
            "use_coverpage": false
        },
        "postage": "priority",
        "plex": "simplex",
        "color": true,
        "state": "opened",
        "state_changed_at": "2015-01-01T12:00:00",
        "created_at": "2015-01-01T12:00:00",
        "transaction" : {
            "state" : "completed",
            "state_changed_at" : "2015-01-01T12:00:00"
        },
    "pu": false,
    "kb": false,
    "consignor_contact": null
}
                

                        
POST /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/envelopes/f6aa0f0a-4514-46e5-be2c-539278a58e70/close HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
                

                        
POST /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/envelopes/f6aa0f0a-4514-46e5-be2c-539278a58e70/cancel HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
                

                        
GET /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/envelopes/f6aa0f0a-4514-46e5-be2c-539278a58e70 HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
    "id": "f6aa0f0a-4514-46e5-be2c-539278a58e70",
    "name": "Invoice 9923891",
    "address": {
    "$type": "postal",
        "name": [
            "Company Inc.",
            "c/o John Doe"
        ],
        "street": [
            "Street no. 37"
        ],
        "postal_code": "65421",
        "city": "Gothenburg",
        "country": "SE"
    },
    "postage": "priority",
    "plex": "simplex",
    "color": true,
    "state": "opened",
    "state_changed_at": "2015-01-01T12:00:00",
    "created_at": "2015-01-01T12:00:00",
    "transaction" : {
        "state" : "completed",
        "state_changed_at" : "2015-01-01T12:00:00"
    },
    "tracking": {
        "tracking_state": "Init",
        "track_url": https://tracking.postnord.com/se/?id=RRXXXXXXXXSE,
        "parcel_no":  RRXXXXXXXXSE "
    }
}
                

                        
Init                      Created, not booked yet
INFORMED                  Booked at Post Nord but not sent yet
EN_ROUTE                  Sent and on its way to the delivery service point
AVAILABLE_FOR_DELIVERY    Delivered to the delivery service point and ready to be collected
RETURNED                  Has been returned
DELIVERED                 Has been delivered/collected
DoneReturned              After RETURNED, we send a notification mail to the user who created the mailing.
Done                      After DELIVERED we send a notification mail to the user who created the mailing.

After the states Done or DoneReturned the tracking of the mailing stops.
                

                        
GET /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/envelopes?name={name}&state={state} HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
[{
    "id": "f6aa0f0a-4514-46e5-be2c-539278a58e70",
    "name": "Invoice 9923891",
    "address": {
        "$type": "postal",
        "name": [
            "Company Inc.",
            "c/o John Doe"
        ],
            "street": [
            "Street no. 37"
        ],
        "postal_code": "65421",
        "city": "Gothenburg",
        "country": "SE"
    },
    "postage": "priority",
    "plex": "simplex",
    "color": true,
    "state": "opened",
    "state_changed_at": "2015-01-01T12:00:00"
    "created_at": "2015-01-01T12:00:00",
    "transaction" : {
        "state" : "completed",
        "state_changed_at" : "2015-01-01T12:00:00"
    }
}]
                

                        
POST /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/envelopes/f6aa0f0a-4514-46e5-be2c-539278a58e70/content HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "data": "YW55IGNhcm5hbCBwbGVhcw==",
    "mime": "application/pdf",
    "length": 1024,
    "type": "document"
}
                

                        
POST /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/
            envelopes/f6aa0f0a-4514-46e5-be2c-539278a58e70/content HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "data": "YW55IGNhcm5hbCBwbGVhcw==",
    "mime": "application/pdf",
    "length": 1024,
    "type": "document",
    "return_address" : "true",
    "address": null (See Address objects postal for exampel when not null)
}
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
    "id": "d2c5fedd-0749-482c-94b9-7f13bd442a04",
    "mime": "application/pdf",
    "length": 1024,
    "type": "document",             
    "return_address" : "false",
    "created_at": "2015-01-01T12:00:00"
}
                

                        
GET /campaigns/4ebeab48-ee03-474f-bc79-c6db082c2bad/
            envelopes/f6aa0f0a-4514-46e5-be2c-539278a58e70/
            content/d2c5fedd-0749-482c-94b9-7f13bd442a04 HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
    "id": "d2c5fedd-0749-482c-94b9-7f13bd442a04",
    "mime": "application/pdf",
    "length": 1024,
    "type": "document",
    "created_at": "2015-01-01T12:00:00"
}
                

                        
POST /edi/sender HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{"Name":"Company Inc",
"Address1":"Street no. 37",
"Address2":"",
"Zip_Code":"65421",
"City":"Gothenburg",
"Country_Code":"SE",
"Contact_Name":"John Doe",
"Phone":"+4670010020",
"Email":"john.doe@companyinc.com",
"CIN":"800101xxxx",
"GLN":"7380000000000",
"VAT":"SE543210123401",
"Bank_Giro":"xxx-xxxx",
"Plus_Giro":"xxxxxxx-x",
"IBAN":"SExxxx.....",
"BIC":"ESSE...."}
                

                        
HTTP/1.1 200 OK 
Content-Type: application/json; charset=UTF-8
{
    "message":"New sender 'Company Inc' registered"
}
                

                        
GET /edi/invitations HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK 
Content-Type: application/json; charset=UTF-8
[{"ReceiverCin":"800101xxxx",
"ReceiverGln":"7380000000000",
"DateSent":"2023-01-17T00:00:00+01:00",
"Status":"1002"},
{"ReceiverCin":"800101xxxx",
"ReceiverGln":"7390000000000",
"DateSent":"2023-01-18T00:00:00+01:00",
"Status":"1001"}]
                

                        
registered = 1001,
sent = 1002,
received = 1003,
answered = 1004,
connection_approved = 1005,
connection_denied = 1006,
reminder_sent = 1007,
insufficient_information = 1008,
unkown_status = 1009,
expired = 1010 
                

                        
GET /edi/update-status HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
[{"ReceiverCin":"800101xxxx",
"ReceiverGln":"7380000000000",
"DateSent":"2023-01-17T00:00:00+01:00",
"Status":"1002"},
{"ReceiverCin":"800101xxxx",
"ReceiverGln":"7390000000000",
"DateSent":"2023-01-18T00:00:00+01:00",
"Status":"1001"}]
                

                        
POST /reachable/ebank HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "recipient": "19800101xxxx"
}
                

                        
POST /reachable/einbox HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "recipient": "19800101xxxx"
}
                

                        
POST /reachable/einbox HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "recipient": "19800101xxxx, 19810101xxxx, 19802101xxxx"
}
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"recipients": [
    {
        "recipient": "19800101xxxx"
    },
    {
        "recipient": "19810101xxxx"
    },
    {
        "recipient": "19820101xxxx"
    }
]
}
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
    "recipient": "19800101xxxx.BNK.SE"
}
                

                        
HTTP/1.1 404 NOT FOUND
Content-Type: application/json; charset=UTF-8
                

                        
POST /reachable/ebank HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "sender": "0000001.000002.SEB.SE",
}
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
[
    {
        "identifier": "19800101xxxx",
        "address": "19800101xxxx.BNK.SE",
        "reachable": true
    },
    {
        "identifier": "19830704xxxx",
        "address": "19830704xxxx.BNK.SE",
        "reachable": true
    }
]
                

                        
HTTP/1.1 404 NOT FOUND
Content-Type: application/json; charset=UTF-8
                

                        
POST /reachable/guardian HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "recipient": "YYYYMMDDXXXX",
}
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
[
        {
            "recipient": "YYYYMMDDXXXX",
            "address_postal": {
                "name": [
                    "Petra Malstroem-Trell"
                ],
                "street": [
                    "MOSSTIGSVAGEN 9"
                ],
                "postal_code": "17238",
                "city": "GOTEBORG",
                "country": "SE"
            }
        },
        {
            "recipient": "",
            "address_postal": {
                "name": [
                    "Petter Klas Flygmann"
                ],
                "street": [
                    "MOSSTIGSVAGEN 9"
                ],
                "postal_code": "17238",
                "city": "GOTEBORG",
                "country": "SE"
            }
        }
]
                

                        
POST /reachable/peppol HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "recipient": "ekopost ab"
}
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
[
    {
        "participantID":{
        "scheme":"iso6523-actorid-upis",
        "value":"0007:559281xxxx"
    },
    "docTypes":[
        {
            "scheme":"busdox-docid-qns",
            "value":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
        },
        {
            "scheme":"busdox-docid-qns",
            "value":"urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
        }
    ],
    "entities":[
        {
            "name":[
                {
                    "name":"Ekopost AB"
                }
            ],
            "countryCode":"SE",
            "geoInfo":"Box 63, \r\nLandskrona, \r\n261 22, \r\nSE"
        }
    ]
    }
]
                

                        
POST /reachable/einvoiceready HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "ReceiverCin": "800101xxxx",
    "SenderCin": "800102xxxx"
}
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
    "ReceiverCin": "800101xxxx",
    "SenderCin": "800102xxxx",
    "Success": true,
    "ErrorMessage": ""
}
                

                        
POST /reachable/mastercard HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json; charset=UTF-8
{
    "first_name": "Test",
    "last_name": "Person",
    "street_address1": "Street 1",
    "city": "Oslo",
    "zip_code": "0123",
    "ssn": "11223344556"
}
                

                        
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"firstname": "Test",
"lastname": "Person",
"street_address1": "Street 1",
"city": "Oslo",
"zip_code": "0123",
"ssn": "11223344556",
"reachable": true,
"identifier": "1234567890"
}
                

                        
{
    "id": "4ebeab48-ee03-474f-bc79-c6db082c2bad",
    "name": "Invoice March 2015",
    "output_date": "2015-01-01T12:00:00",
    "cost_center": "Finance Office",
    "envelope_count": 1,
    "state": "opened",
    "state_changed_at": "2015-01-01T12:00:00",
    "created_at": "2015-01-01T12:00:00"
}
                

                        
{
    "id": "f6aa0f0a-4514-46e5-be2c-539278a58e70",
    "name": "Invoice 9923891",
    "address": {
        "$type": "postal",
        "name": [
            "Company Inc.",
            "c/o John Doe"
        ],
        "street": [
            "Street no. 37"
        ],
        "postal_code": "65421",
        "city": "Gothenburg",
        "country": "SE"
    },
    "postage": "priority",
    "plex": "simplex",
    "color": true,
    "state": "opened",
    "state_changed_at": "2015-01-01T12:00:00",
    "created_at": "2015-01-01T12:00:00",
    "transaction" : {
        "state" : "completed",
        "state_changed_at" : "2015-01-01T12:00:00"
    }
}
                

                        
  {
    "$type": "postal",
    "name": [
        "Company Inc.",
        "c/o John Doe"
    ],
    "street": [
        "Street no. 37"
    ],
    "postal_code": "65421",
    "city": "Gothenburg",
    "country": "SE",
    "use_coverpage": true
}
                  

                        
  {
    "$type": "email",
    "subject": "Invoice 9923891",
    "recipient": "johndoe@johndoe.com"
}
                  

                        
{
    "$type": "einbox_kivra",
    "subject": "Bokning 1543",
    "recipient": "19590422XXXX",
    "kivra_type": 3,
    "booking": {
        "title": "Välkommen på årets besök",
        "start_time": "2021-03-06 15:00",
        "end_time": "2021-03-06 17:30",
        "description": "Beskrivning av händelse",
        "location": "Drottningtorget 5, 411 03 Göteborg",
        "info_url": "https://www.ekopost.se"
    }
}
                

                        
{
    "$type": "einbox_kivra",
    "subject": "faktura 02102",
    "recipient": "19830706XXXX",
    "kivra_type": 1,
    "invoice": {
        "reference": "01253679",
        "payable": true,
        "currency": "SEK",
        "due_date": "2021-06-28",
        "total_owed": "123.75",
        "use_ocr": false,
        "use_bg": true,
        "account": "0000-0000",
        "payment_reference": "1234023"
    }
}
                

                        
{
    "$type": "einbox",
    "subject": "Invoice 9923891",
    "recipient": "19800101xxxx"
}
                

                        
{
    "$type": "einbox_signer",
    "info_mail": "infoepost@företaget1.com",
    "signers": [
        {
            "email": "johndoe1@johndoe1.com",
            "recipient": "19800101xxxx",
            "issuer": true,
        },
        {
            "email": "johndoe2@johndoe2.com",
            "recipient": "19800202xxxx",
            "issuer": false,
        }
    ]
}
                

                        
{
    "$type": "einvoice",
    "format": "svefaktura-1.0",
    "sender": "556838-4118",
    "sender_type": "SE.REGNO",
    "recipient": "556838-4118",
    "recipient_type": "SE.REGNO",
    "intermediator": null
}
                

                        
{
    "$type": "lookup",
    "recipient": "18750710XXXX"
}
                

                        
{
    "$type": "ebank",
    "recipient": "5568384118.BNK.SE",
    "customer_number": "556838-4118",
    "customer_name": "No Ink AB",
    "invoice_number": "556838",
    "reference_type": "ocr",
    "reference_value": "0000556838411800",
    "giro_number": "55683841",
    "autogiro": true,
    "amount": 499.99,
    "invoice_date": "2015-01-01T00:00:00",
    "due_date": "2015-01-31T00:00:00"
}
                

                        
{
    "$type": "protected",
    "recipient": "yyyyMMdd-xxxx",
    "use_coverpage": true
}
                

                        
{
    "$type": "einvoice_mastercard",
    "sender_id": "12345",
    "kid": "",
    "issuer": "987654321",
    "shipment_id": "4357b0f9-2d83-4782-ab24-aa590c7027f7",
    "account_number": "22113344665",
    "amount": 100.00,
    "due_date": "2024-01-01",
    "payment_type": "EFAKTURA",

    // only one of the three following should be set, depending on if you send efaktura, avtalsgiro etc.
    "efaktura_identifier": "789456123", // use the reachable api to get the efaktura identifier if you don't already have it.
    "social_security_number": null,
    "e_faktura_reference": null,

    "minimum_amount": null,
    "brand_name": null, // must be set on EFAKTURA(*)
    "e_faktura_url": null,
    "collection_notice_notification_email":null,
    "collection_notice_notification_mobile_phone": null,

    // atg
    "atg_notification": false,
    "atg_notification_text": null,
    "atg_abbreviated_name": null,
    "atg_external_reference": null"
}
        or shorter version for EFAKTURA:
{
    "$type": "einvoice_mastercard",
    "sender_id": "12345",
    "kid": "22330044"
    "issuer": "987654321",
    "account_number": "22113344665",
    "amount": 100.00,
    "due_date": "2024-01-01",
    "payment_type": "EFAKTURA",
    "brand_name": "Your company name"
    
    // only one of the three following should be set, depending on if you send efaktura, avtalsgiro etc.
    "efaktura_identifier": "789456123",
    "minimum_amount": null
}
                

                        
"transaction" : {
    "state" : "completed",
    "state_changed_at" : "2015-01-01T12:00:00"
}
                

                        
{
    "id": 100,
    "mime": "application/pdf",
    "length": 1024,
    "type": "document",
    "created_at": "2015-01-01T12:00:00"
}
                

                        
{
    "error_code": "0",
    "error_message": "Invalid basic authentication token.",
    "developer_message": "Please verify that the account is activated and the username and password are valid."
}
                

                        
PM >  Install-Package Ekopost
                

                        
Using the Ekopost nuget package
            Table of contents
            5 step walkthrough
            
            the minimum required steps needed to schedule an envelope
            
                initialize
                create a new campaign
                create a new Envelope
                create a new Content
                close the campaign and envelope
            
            cancel and review objects
            creating an Ebank Address object
            5 step walkthrough
            Initialization
            
            Setting up the Ekopost class to target your account.
            
            In order to integrate with Ekopost you must first provide an API key that is linked to your account, this key can be found in the portal https://secure.ekopost.se. Once you have your key you can use it as a parameter to instantiate an Ekopost object as seen in [CODE EXAMPLE 1] below
            
            
            [CODE EXAMPLE 1] -initialize
            - - - - - - - - - - - - - - - - - - - - -
            using Ekopost.Contracts;
            .
            .
            .
            1 var eko = new Ekopost.Ekopost("apikeystring");
            .
            .
            .
            - - - - - - - - - - - - - - - - - - - - -
            
            Now when we have an Ekopost object, [eko], there are 3 important functions to note:
            
                eko.CampaignSet.Create();
                eko.EnvelopeSet.Create(Guid campaignId);
                eko.ContentSet.Create(Guid campaignId, Guid envelopeId);
            
            In this tutorial we will go through each of the objects created by these functions with example of how to use them and in the process we will have scheduled our first mail for delivery using the Ekopost nuget package.
            
            Content can be thought of as the letter that you wish to send. That letter needs to be put in an envelope and a campaign can contain multiple envelopes. When we code this using the nuget package we do it in reverse and create the campaign first, then the envelope and finally the content. Lets get started with the campaign
            
            
            Campaign
            
            [CODE EXAMPLE 2] -create a new campaign
            - - - - - - - - - - - - - - - - - - - - -
            .
            .
            .
            1 var newCampaign = new Campaign("myFirstCampaign","", DateTime.Now.AddHours(2));
            2
            3 var campaignSet = eko.CampaignSet.Create();
            4
            5 var registeredCampaign = campaignSet
            6	.Create(newCampaign)
            7	.Resource;
            .
            .
            .
            - - - - - - - - - - - - - - - - - - - - -
            
            first we create a campaign object on line 1. In the example it has been given a name [myFirstCampaign], providing a blank cost center and schedules the send outs to two hours from now.
            
            Next we use the first function mentioned above to create a CampaignSet object, this is what we use when we want to manipulate campaigns.
            
            Note that no interaction with Ekopost has yet occurred, on the line 6 however an API call is made by calling the Create() function campaignSet. This function return a wrapper object with metadata on the API call, the Resource property contains the registered campaign. We are interested in the returned campaign object because it contains an Id that needs to be referenced in our next step.
            
            
                                    
            Envelope
            
            [CODE EXAMPLE 3] -create a new Envelope
            - - - - - - - - - - - - - - - - - - - - -
            .
            .
            .
            1 var postalAddress = new AddressPostal(
            2 	new[] { "Johnny Doh" },
            3 	new[] { "Ekovägen 12" },
            4 	"43215",
            5 	"Ekostaden",
            6	"SE");
            7 var envelope = new Envelope("firstLetter", postalAddress, Postage.Economy, Plex.Simplex, false);
            8 var envelopeSet = eko.EnvelopeSet.Create(registeredCampaign.Id);
            9 var registeredEnvelope = envelopeSet
            10 	.Create(envelope)
            11 	.Resource;
            .
            .
            .
            - - - - - - - - - - - - - - - - - - - - -
            
            an envelope needs a destination, so we start by making an address object on line 1-6. There are multiple address types however this tutorial covers only a postal address type. Now when we have an address we can use it as a parameter when creating an envelope as is seen on line 7. Once again we create a Set item (line 8), this time the EnvelopeSet, so that we can manipulate envelopes in Ekopost, note that we need to use the Id of the campaign item [registeredCampaign] we received in [CODE EXAMPLE 2]. Just like before we make an API call and register our envelope with Ekopost via the Create() method on line 9-11.
            
            
                                    
            Content
            
            [CODE EXAMPLE 4] -create a new Content
            - - - - - - - - - - - - - - - - - - - - -
            .
            .
            .
            1 var content = new Content(ContentType.Document, "~path/to/file/on/disk/aletter.pdf");
            2 var contentSet = eko.ContentSet.Create(registeredCampaign.Id, registeredEnvelope.Id);
            3 contentSet.Create(content);
            .
            .
            .
            - - - - - - - - - - - - - - - - - - - - -
            
            this is where we upload our letter, what we call content. It is required that an envelope contains a document type Content, this is the main content of any envelope, so on line 1 we create such content. In this example we point to the file that we want to upload from disk by using a path parameter. Next, line 2, we use our last Set item, namely that of a ContentSet, to manage our content, this time we need to supply the campaign [registeredCampaign] id from [CODE EXAMPLE 2] and also the envelope [registeredEnvelope] Id from [CODE EXAMPLE 3]. Finally on line 3 we make the API call.
            
            OK all set? Not quite!
            
            More envelopes and more content can be created as desired, once done we need to mark the campaign and the envelope as ready for delivery
            
            
                                    
            Close
            
            [CODE EXAMPLE 5] -close the campaign and envelope
            - - - - - - - - - - - - - - - - - - - - -
            .
            .
            .
            1 envelopeSet.Close(registeredEnvelope.Id);
            2 campaignSet.Close(registeredCampaign.Id);
            .
            .
            .
            - - - - - - - - - - - - - - - - - - - - -
            
            by using our Set objects we call the close function on both envelopes and campaigns, this will mark them as ready for our system to send them on to their destination. Note that once they are closed you may no longer modify them, you may however cancel, provided you do it before the scheduled send out time.
            
            
                                    
            Cancel and Review
            
            [CODE EXAMPLE 6] - cancel and review objects
            - - - - - - - - - - - - - - - - - - - - -
            .
            .
            .
            1 envelopeSet.Cancel(registeredEnvelope.Id);
            2 campaignSet.Cancel(registeredCampaign.Id);
            3 envelopeSet.List().Resource;
            4 campaignSet.List().Resource;
            .
            .
            .
            - - - - - - - - - - - - - - - - - - - - -
            
            Line 1 and 2 shows how to cancel envelopes and campaigns respectively
            
            line 3 and 4 shows how to retrieve a collection of envelopes and campaigns respectively. The List() function also accepts parameters to filter the returned result.
                envelopeSet has string name and string state as filter parameters and
                campaignSet has DateTime? start, DateTime? stop, string name and string state.
            Using the Ebank Address object
            
            When sending an invoice directly to a customers bank account, the Ebank address should be used. this object (ebankAddress) will replace the postalAddress object from [CODE EXAMPLE 3] when creating an Envelope.
            
            
                [CODE EXAMPLE 7] - Creating an Ebank Address object
                - - - - - - - - - - - - - - - - - - - - -
                .
                .
                .
                1 var ebankAddress = new AddressEbank(
                2 "5568384118.BNK.SE",
                3 "556838-4118",
                4 "No Ink AB",
                5 "556838",
                6 ReferenceTypes.Ocr,
                7 "0000556838411800",
                8 "5568-3841",
                9 false,
                10 499.99M,
                11 Convert.ToDateTime("2019-09-17T00:00:00"),
                12 Convert.ToDateTime("2019-09-20T00:00:00"));
                .
                .
                .
                - - - - - - - - - - - - - - - - - - - - -
            
            The parameters used when creating an Ebank address are further described in the Object (ebank) section above
                

                        
POST /payload HTTPS/1.1
Host: localhost:4567
X-Ekopost-Signature: 7d38cdd689735b008b3c702edd92eea23791c5f6
Content-Type: application/json
[
    {
        "ObjectId": "5b161d7a-8a62-44ca-94c2-a2d9d2819be3",
        "StatusName": "posted"
    },
    {
        "ObjectId": "9916aa7a-442a-8a62-94c2-a2d672819b99",
        "StatusName": "posted"
    }
]
                

                        
POST /payload HTTPS/1.1
Host: localhost:4567
X-Ekopost-Signature: 7d38cdd689735b008b3c702edd92eea23791c5f6
Content-Type: application/json
[
    {
        "ObjectId": "a8f7c909-795b-42eb-9068-14638f8e1f83",
        "StatusName": "Completed",
        "DeliveryReports":[
            {
                "Recipient":"+46701010101","Status":"Delivered"
            }
        ]
    }
]
                

                        
private IRestResponse Get(string url)
{
    var client = new RestClient();
    var request = new RestRequest($"{_host}{url}");

    request.Method = Method.GET;
    request.AddHeader("Authorization", $"api-key {_apiKey}");
    request.AddHeader("Content-Type", "application/json; charset=UTF-8");

    return client.Get(request);
}
                

                        
private IRestResponse Post(string url, string requestBody = null)
{
    var client = new RestClient();
    var request = new RestRequest($"{_host}{url}").AddJsonBody(requestBody);
    
    request.Method = Method.POST;
    request.AddHeader("Authorization", $"api-key {_apiKey}");
    request.AddHeader("Content-Type", "application/json; charset=UTF-8");

    return client.Post(request);
}
                

                        
var body = new
{
    // Required
    From = "Test",                                              // Sender name or phone number *
    Recipient = "+46701010101",                                 // Recipient phone number *
    Text = "Test text",                                         // Sms text content
    Title = "Dispatch title",                                   // Description of the sms

    // Optional
    Cost_Center = "Tester",                                     // Cost center
    Unique_Id = "ref-22345-3",                                  // Unique id to prevent duplicates
    Webhook_Url = "https://webhooks.codeexamples.abc/sms"        // Where to receive status webhook
};

var result = Post("dispatch/sms/", JsonConvert.SerializeObject(body, Formatting.None));

/* ToDo: Check result status */

dynamic response = JsonConvert.DeserializeObject(result.Content);

/* ToDo: Check response status */

// Poll sms by Id
var pollByIdResult = Get($"dispatch/sms/{response.id.ToString()}");

// Poll sms by UniqueId
var pollByUniqueResult = Get($"dispatch/sms/unique/{response.unique_id.ToString()}");
        
                

                        
{
  "from": "Test",
  "recipient": "+46701010101",
  "text": "VGVzdCB0ZXh0",
  "delivery_status": "Sending",
  "id": "793b8222-6565-45a7-940d-21897a5c433f",
  "type": "SMS",
  "state": "Transferred",
  "channel": "api",
  "created": "2024-02-07T11:40:00.6999378Z",
  "title": "Dispatch title",
  "cost_center": "Tester",
  "unique_id": "ref-22345-3"
}
                

                        
{
  "from": "Test",
  "recipient": "+46701010101",
  "text": "VGVzdCB0ZXh0",
  "delivery_status": "Delivered",
  "delivery_status_message": "",
  "id": "793b8222-6565-45a7-940d-21897a5c433f",
  "type": "SMS",
  "state": "Completed",
  "channel": "api",
  "created": "2024-02-07T11:40:00Z",
  "title": "Dispatch title",
  "cost_center": "Tester",
  "unique_id": "ref-22345-3"
}
                

                        
// Create campaign
var campaignBody = new
{
    name = "Replymail example",
    output_date = DateTime.Now,
    cost_center = "",
    replymail = true   // 1.
};

var createCampaignResult = Post($"/campaigns/", JsonConvert.SerializeObject(campaignBody, Formatting.None));
var createCampaignObject = JsonConvert.DeserializeAnonymousType(createCampaignResult.Content, new { id = "" });
                

                        
// Attach the reply mail template
bytes = File.ReadAllBytes(@"File\Mall för svarsbrev för Svarspost ver 2.pdf");
fileBase64 = Convert.ToBase64String(bytes);
var attachmentBody = new
{
    data = fileBase64,
    mime = "application/pdf",
    length = 1024,
    type = "replymail",  // 2.
};

createContentResult = Post($"campaigns/{createCampaignObject.id}/envelopes/{createEnvelopeObject.id}/content",
    JsonConvert.SerializeObject(attachmentBody, Formatting.None));
createContentObject = JsonConvert.DeserializeAnonymousType(createContentResult.Content, new { id = "" });
                

                        
// Create envelope
var envelopeBody = new
    {
        name = "A protected letter",
        postage = "protected",                      // 1
        plex = "simplex",
        color = false,
        address = new JObject
            {
                { "$type", "protected" },           // 2
                { "recipient", "998811-XXXX" },     // 3
                { "use_coverpage", false}
        }
    };

var createEnvelopeResult = Post($"campaigns/{createCampaignObject.id}/envelopes",
JsonConvert.SerializeObject(envelopeBody, Formatting.None));
var createEnvelopeObject = JsonConvert.DeserializeAnonymousType(createEnvelopeResult.Content, new { id = "" });