/api/login - Login

Login is required to retrieve data from CITiO APIs.

The login route requires user credentials. It will set up the user session and return a JSON with the User description and a session_id cookie required to use other APIs.

Methods

  • GET /api/login Basic access authentification

Request syntax

GET https://{agency_name}.gateway.cit.io/api/login

Request Header

Key

Value

Authorization (Required)

Basic <credentials>, where credentials is the Base64 encoding of username and password joined by a single colon :

Response

If the login succeed, it return the user configuration and accesses to products, modules and kpis.

It also sets a sessionid cookie, that will be required to requests CITiO APIs.

Response Code

Response Content

200

JSON-formatted object

401

{"message": "Unsuccessful login attempt"}

{
    "message": "Login successful for user " + username,
    "username": <str>,
    "products": <list[str]>,
    "modules": <list[str]>,
    "language": {"default"/"en"/"fr"}
    "kpis": {
        "Ridership": <list[str]>,
        "Operations": <list[str]>,
        "Course": <list[str],
        "FraudStatistics": <list[str]
    }
}

Sample request

curl --cookie-jar cookies.txt -H "Authorization: Basic aW50ZXJzdGVsbGFyQG1haWwuY29tOmF6ZXJ0eTEyMw==" https://orleansmetropole.gateway.cit.io/api/login

Sample response

{
    "message": "Login successful for user interstellar@mail.com",
    "username": "interstellar@mail.com",
    "products": ["Analytics", "Fraud"],
    "modules": [
        "Replay",
        "Ridership",
        "Operations",
        "Course",
        "FraudDashboard",
        "FraudStatistics",
        "NextDepartures",
    ],
    "language": "default",
    "kpis": {
        "Ridership": [
            "TicketsIn",
            "OD",
            "TripsKm",
            "OccupancyTicketing",
            "OccupancyCountingCells",
            "BoardingTicketing",
            "BoardingCountingCells",
            "TicketingOvercrowding",
            "CountingCellsOvercrowding",
        ],
        "Operations": [
            "DelayStop",
            "DelayCourse",
            "PunctualityStop",
            "PunctualityCourse",
            "RegularityCourse",
            "NumCourses",
            "CommercialSpeed",
            "TravelTime",
        ],
        "Course":  [
            "OccupancyCountingCells",
            "OccupancyTicketing",
            "TravelTime",
            "DelayDeparture",
            "CommercialSpeed"
        ],
        "FraudStatistics": [
            "FraudBoarding",
            "FraudOnBoard",
            "FraudAlighting",
            "FraudLegalBoarding",
            "FraudLegalAlighting",
            "ControlsDone",
            "ControlsContraventions",
            "ControlsRecovered",
            "FraudAmount"
        ]
    }
}

Avez-vous trouvé ce que vous cherchiez ?

/kpis/tc/overcrowding/

/kpis/ticketing/{filter_level}[/{filter_level_id}]/{aggregation_level}

Contact