# mgp25/sc-api architecture

> Architecture diagram of the GitHub repository mgp25/sc-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mgp25/sc-api
- Repository: https://github.com/mgp25/sc-api

## Overview

##### Project type and purpose
- This is a PHP client‐library (Composer package “mgp25/snapapi”) that wraps the Snapchat/Casper API for other PHP apps or scripts. It is not a full web app or microservice fleet, but a reusable API wrapper with built-in crypto, caching, and example clients.

##### File structure
- Top‐level:
- composer.json, README.md, LICENSE – package metadata
- examples/ – standalone PHP scripts that consume the library
- src/ – library code and assets:
- src/Casper-API-PHP/ – core API wrapper classes (CasperAPI, CasperAgent, exceptions)
- src/phpseclib/ – 3rd‐party crypto modules (AES, RSA, Hash, BigInteger, etc.)
- src/snapchat*.php – high‐level Snapchat‐specific facades
- src/func.php – utility functions
- src/authData/, src/cache/ – local filesystem storage for tokens, session data
- src/fonts/, src/ca_bundle.crt – assets for HTTPS and story rendering
- src/snaps/, src/stories/, src/Discover/ – placeholder folders for downloaded media

##### README
- Confirms Composer installation, need for Casper API key/secret, shows example usage.
- Points to Casper.io service as the external backend.

a. Main components
– CLIENT SCRIPTS (examples/*.php)
– SNAPAPI LIBRARY
· Entry point: CasperAPI
· HTTP/crypto layer: CasperAgent + phpseclib modules
· Facade: snapchat.php / snapchat_agent.php / snapchat_cache.php
· Utils: func.php
· Local storage: authData, cache, fonts, ca_bundle.crt
– EXTERNAL SERVICE: Casper API (HTTPS endpoints)
b. Relationships & data flow
1. Developer script → instantiates CasperAPI with credentials
2. CasperAPI calls CasperAgent to build/encrypt HTTP request (uses phpseclib)
3. CasperAgent → sends HTTPS request → Casper API service
4. Response → CasperAgent decrypts/parses → CasperAPI returns data
5. CasperAPI writes session tokens/media to local folders (authData, cache, snaps, stories)
c. Architectural patterns
– Facade/wrapper over low‐level HTTP + crypto operations
– Layered: API classes → Transport/crypto layer → Storage layer
– Dependency isolation: phpseclib vendored under src/phpseclib
d. Key technologies & libraries
– PHP 7+ with Composer
– phpseclib for encryption (AES, RSA, etc.)
– Casper API over HTTPS
– Filesystem storage for caching and media

##### Be detailed but focused
- Every directory that plays a runtime role (phpseclib, authData, cache, fonts)
- Two main layers (API facade vs. transport/crypto)
- Local filesystem as a first‐class “component”

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Scripts
    subgraph "Client Scripts"
        examples["examples/"] 
    end

    %% SnapAPI Library
    subgraph "SnapAPI Library"
        subgraph "Facade Layer"
            CasperAPI["CasperAPI"]:::lib
            snapchat["snapchat.php"]:::lib
            snapchat_agent["snapchat_agent.php"]:::lib
            snapchat_cache["snapchat_cache.php"]:::lib
        end
        subgraph "Transport & Crypto Layer"
            CasperAgent["CasperAgent"]:::lib
            CasperException["CasperException"]:::lib
            phpseclib["phpseclib/"]:::vendor
        end
        Utility["func.php"]:::lib
        subgraph "Assets"
            ca["ca_bundle.crt"]:::lib
            fonts["fonts/Helvetica.otf"]:::lib
        end
        subgraph "Local Storage"
            auth["authData/"]:::storage
            cache["cache/"]:::storage
            snaps["snaps/"]:::storage
            stories["stories/"]:::storage
            discover["Discover/"]:::storage
        end
    end

    %% External Service
    CasperAPIService["Casper API Service"]:::external

    %% Data Flows
    examples -->|"uses facade"| snapchat
    examples -->|"uses facade"| snapchat_agent
    examples -->|"uses facade"| snapchat_cache
    snapchat -->|"calls"| CasperAPI
    snapchat_agent -->|"calls"| CasperAPI
    snapchat_cache -->|"calls"| CasperAPI
    CasperAPI -->|"builds request"| CasperAgent
    CasperAgent -->|"uses crypto"| phpseclib
    CasperAgent -->|"sends HTTPS"| CasperAPIService
    CasperAPIService -->|"response"| CasperAgent
    CasperAgent -->|"decrypts/parses"| CasperAPI
    CasperAPI -->|"returns data"| examples
    CasperAPI -->|"stores session/media"| auth
    CasperAPI -->|"stores session/media"| cache
    CasperAPI -->|"stores session/media"| snaps
    CasperAPI -->|"stores session/media"| stories
    CasperAPI -->|"stores session/media"| discover
    CasperAPI -->|"uses utilities"| Utility
    CasperAgent -->|"uses utilities"| Utility

    %% Click Events
    click examples "https://github.com/mgp25/sc-api/tree/master/examples/"
    click CasperAPI "https://github.com/mgp25/sc-api/blob/master/src/Casper-API-PHP/CasperAPI.php"
    click CasperAgent "https://github.com/mgp25/sc-api/blob/master/src/Casper-API-PHP/CasperAgent.php"
    click CasperException "https://github.com/mgp25/sc-api/blob/master/src/Casper-API-PHP/CasperException.php"
    click phpseclib "https://github.com/mgp25/sc-api/tree/master/src/phpseclib/"
    click snapchat "https://github.com/mgp25/sc-api/blob/master/src/snapchat.php"
    click snapchat_agent "https://github.com/mgp25/sc-api/blob/master/src/snapchat_agent.php"
    click snapchat_cache "https://github.com/mgp25/sc-api/blob/master/src/snapchat_cache.php"
    click Utility "https://github.com/mgp25/sc-api/blob/master/src/func.php"
    click auth "https://github.com/mgp25/sc-api/tree/master/src/authData/"
    click cache "https://github.com/mgp25/sc-api/tree/master/src/cache/"
    click snaps "https://github.com/mgp25/sc-api/tree/master/src/snaps/"
    click stories "https://github.com/mgp25/sc-api/tree/master/src/stories/"
    click discover "https://github.com/mgp25/sc-api/tree/master/src/Discover/"
    click ca "https://github.com/mgp25/sc-api/blob/master/src/ca_bundle.crt"
    click fonts "https://github.com/mgp25/sc-api/blob/master/src/fonts/Helvetica.otf"

    %% Styles
    classDef lib fill:#8FBC8F,stroke:#333,stroke-width:1px
    classDef vendor fill:#FFA500,stroke:#333,stroke-width:1px
    classDef storage fill:#87CEFA,stroke:#333,stroke-width:1px
    classDef external fill:#DDA0DD,stroke:#333,stroke-width:1px
```
