Skip to content

Home

Jump to bottom
Ryan Hodges edited this page Mar 12, 2025 · 7 revisions

Madrona Portal:

Core module for the Madrona Portal Suite

Authentication with Django

If you can load an HTML page in your workflow and capture cookies, the endpoint for loading the login form (if available) is at /account/. After successful authentication, two cookies are added to your browser: csrftoken and sessionid. Both of these have an expiration you should be mindful of if you are storing remotely. Of these, sessionid is the one you will need to provide for most of the authentication-required API calls below.

Some of the API documentation below does not rely on authentication (see 'Data Manager'). Others may use Django REST Framework, which is well documented elsewhere. Anything else requires using a browser to capture those cookies.

API Documentation

  • Data Manager
    • This module manages organizing themes and layers as presented on the map ('visualize') tool.
    • Use this API to query for querying all publicly available layers/themes for all information related to how to display them and how to organize them.
    • This module is actively being replaced by MP-Layers. Once complete, that API will supersede this, but for now it is backward compatible, and this API doc should work for portals using either module.
  • Visualize (Coming soon!)
    • This module is primarily focused on presenting the map view to the user, but it hosts some custom models as well, including user-saved bookmarks and user-imported layers.
    • Use this API to query for a user's Bookmarks or Imported layers.
  • Drawings
    • This module enables users to draw, style, and share custom shapes with descriptions.
    • Use this API to get the list of all drawings visible to a user.
  • Map Groups
    • Users may belong to groups and share custom data including bookmarks, drawings, and user-imported layers with those groups.
    • This API enables you to see which groups a user belongs to, or what public groups are available to join.

RPC

Several of the older modules still make use to Remote Procedure Calls (RPC) for an API. This is currently provided by RPC4Django. Many of these require authentication (which requires a session ID which is only made available to browsers, see above). However, you can get a full list of what endpoints exist by viewing your portal's RPC endpoint at /rpc.

Clone this wiki locally